{
  "version": 1,
  "name": "Firefly III documentation",
  "documents": [
    {
      "id": "index.md",
      "kind": "page",
      "title": "Firefly III documentation",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/",
      "markdown": "https://sourcey-firefly.pages.dev/index.md",
      "file": "index.md",
      "searchText": "\n# Firefly III documentation {#firefly-iii-documentation}\n\n\nWelcome. 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.\n\n\n## [Tutorials](/tutorials/) {#tutorials}\n\n\nDo you want to learn the basics of how to use **Firefly III** and the **Data Importer**? Check out the [tutorials](/tutorials/) section to find such information as:\n\n- [Set up your first set of bank accounts](/tutorials/finances/first-steps/)\n- [Predict expenses using subscriptions](/tutorials/finances/subscription/)\n\nMore tutorials can be found in the [tutorials](/tutorials/) section.\n\n\n## [How-to guides](/how-to/) {#how-to-guides}\n\n\nDo you want to learn how to do specific tasks? Check out the [how-to guides](/how-to/) section to find such information as:\n\n- [How to install Firefly III](/how-to/firefly-iii/installation/docker/)\n- [How to install the Data Importer](/how-to/data-importer/installation/docker/)\n- [How to use the command line](/how-to/firefly-iii/features/cli/)\n- [How to manage budgets](/how-to/firefly-iii/finances/budgets/)\n\nMore guides can be found in the [how-to guides](/how-to/) section.\n\n\n## [References](/references/) {#references}\n\n\nDo you want to learn what **Firefly III** and the **Data Importer** are capable of? Check out the [references](/references/) section to find such information as:\n\n- [How to use the Firefly III API](/references/firefly-iii/api/)\n- The structure of [transactions](/references/firefly-iii/transaction-types/) and [accounts](/references/firefly-iii/account-types/)\n\nMore references can be found in the [references](/references/) section.\n\n\n## [Explanation](/explanation/) {#explanation}\n\n\nDo you want to learn what **Firefly III** is about? Check out the [explanation](/explanation/) section to find such information as:\n\n- [Who maintains Firefly III, and why](/explanation/support/)\n- [What the financial concepts behind Firefly III are](/explanation/financial-concepts/transactions/)\n\nMore explanations can be found in the [explanation](/explanation/) section.\n\n\n## [API reference](/api/) {#api-reference}\n\n\nDo you want to talk to **Firefly III** from your own code? The [API reference](/api/) documents every endpoint of the Firefly III API, with requests you can try against your own installation. Start with [how to use the API](/how-to/firefly-iii/features/api/) to set up access.\n\n<!-- HELP TEXT -->\n\n\n## Do you need help, or do you want to get in touch? {#do-you-need-help-or-do-you-want-to-get-in-touch}\n\n\nDo you want to contact me? You can email me at [james@firefly-iii.org](mailto:james@firefly-iii.org) or get in touch through one of the following support channels:\n\n- [GitHub Discussions](https://github.com/firefly-iii/firefly-iii/discussions/) for questions and support\n- [Gitter.im](https://gitter.im/firefly-iii/firefly-iii) for a good chat and a quick answer\n- [GitHub Issues](https://github.com/firefly-iii/firefly-iii/issues) for bugs and issues\n- <a rel=\"me\" href=\"https://fosstodon.org/@ff3\">Mastodon</a> for news and updates\n\n<!-- END OF HELP TEXT -->\n\n<!-- SPONSOR TEXT -->\n\n\n## Support the development of Firefly III {#support-the-development-of-firefly-iii}\n\n\nFirefly III is a side gig. With your sponsorship or support, I can spend more time on Firefly III. So, if you like Firefly III, and if it helps you save lots of money, why not send me a dime for every dollar saved! 🥳\n\nOK, that was a joke. But for real, when you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my [Patreon](https://www.patreon.com/jc5) and [GitHub Sponsors](https://github.com/sponsors/JC5) page for more information. You can also [buy me a ☕️ coffee at ko-fi.com](https://ko-fi.com/Q5Q5R4SH1) or send something my way using [Liberapay](https://liberapay.com/JC5). Thank you for your consideration.\n\n\n### Sponsorships {#sponsorships}\n\n\nFirefly III is sponsored by TestMu AI. Their support allows me to test Firefly III more easily and introduce even fewer bugs with every release.\n\nBrowser testing via TestMu AI:\n\n<a href=\"https://www.testmuai.com/?utm_source=fireflyiii&utm_medium=sponsor\" target=\"_blank\">\n<img src=\"/_media/59e406ce9676e24c2e22.png\" alt=\"TestMu AI\" style=\"vertical-align: middle;\" width=\"250\" />\n</a>\n\n<!-- END OF SPONSOR TEXT -->\n\n",
      "documentId": "index",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/",
          "markdown": "https://sourcey-firefly.pages.dev/index.md"
        }
      ]
    },
    {
      "id": "tutorials/index.md",
      "kind": "page",
      "title": "Tutorials",
      "description": "Check out the following tutorials for Firefly III and the Data Importer.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/index.md",
      "file": "tutorials/index.md",
      "searchText": "\n# Tutorials {#tutorials}\n\n\nCheck out the following tutorials for **Firefly III** and the **Data Importer**.\n\nPlease take note that you can learn how to install **Firefly III** or the **Data Importer** from the **[how-to guides](/how-to/)**.\n\nThe menu on the left will guide you through the tutorial section.\n\nPopular choices are:\n\n1. Learn to [import a simple CSV file using the Data Importer](/tutorials/data-importer/csv/)\n2. Learn to [process refunds](/tutorials/finances/refund/)\n\nMore choices are in the menu.\n\n\n## Missing something? {#missing-something}\n\n\n- You think a specific tutorial should be written, and you wish to write it.\n- You think a specific tutorial should be written, and you don't wish to write it.\n- You spotted inaccuracies, improper grammar, or spelling mistakes.\n\nPlease start a [discussion](https://github.com/orgs/firefly-iii/discussions/new/choose). Your contributions are appreciated.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nCheck out the [support page](/explanation/support/).\n",
      "documentId": "tutorials",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/first-steps/index.md",
      "kind": "page",
      "title": "My first accounts",
      "description": "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?",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/index.md",
      "file": "tutorials/finances/first-steps/index.md",
      "searchText": "\n# My first accounts {#my-first-accounts}\n\n\nLet's assume you managed to install Firefly III using the [how-to guides](/how-to/). You've got a working installation, and you're ready to go. What's next?\n\nIn this tutorial you will learn how to set up your first accounts, so they match your bank statements. You will also learn how to create some transactions.\n\nThis tutorial assumes you already registered yourself, which is the final step of the installation procedure. As you finish the installation and visit Firefly III for the *first* time, you will see a registration form. Fill it in to create your new account, if you have not already done so.\n\n\n## First setup {#first-setup}\n\n\nYou will see this screen when you run Firefly III for the first time (after registration):\n\n![Opening wizard](/_media/de57f98789f172b42675.png)\n\nChoose your currency and language.\n\nFill in the name of your bank. If you know your bank account's balance, don't fill it in. Instead, fill in *yesterday's* balance. This will make sure you can create transactions from today.  Firefly III will calculate today's balance for you, and this is a nice way to check if everything works as expected.\n\nSimilarly, fill in yesterday's savings account balance, if you happen to have a savings account.\n\n\n## Check for correctness {#check-for-correctness}\n\n\nOnce you have filled in these details, the home page of Firefly III greets you.\n\n![Result](/_media/c835f066cc2fdc1a73a5.png)\n\nIn the left menu, click Accounts > Asset accounts. Here you should see your bank accounts and some extra's, with yesterday's balance.\n\n\n## Would you like to learn more? {#would-you-like-to-learn-more}\n\n\n- [Tutorial: create accounts and transactions](/tutorials/finances/first-accounts/)\n- [How to organize transactions](/how-to/firefly-iii/finances/transactions/)\n\n\n",
      "documentId": "tutorials/finances/first-steps",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/first-steps/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/first-accounts/index.md",
      "kind": "page",
      "title": "Create accounts and transactions",
      "description": "Let's assume you managed to install Firefly III using the how-to guides",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/index.md",
      "file": "tutorials/finances/first-accounts/index.md",
      "searchText": "\n# Create accounts and transactions {#create-accounts-and-transactions}\n\n\nLet's assume you managed to install Firefly III using the [how-to guides](/how-to/)\n\nThis tutorial assumes you already registered yourself, as it is explained in the [how-to guides](/how-to/), and expands upon [\"my first accounts\"](/tutorials/finances/first-steps/) tutorial.\n\n\n## Create a transaction {#create-a-transaction}\n\n\nLet's create our first transaction. Use your bank statements to find out which transactions we can create. Since we entered yesterday's balance in the account form,\nit's best to recreate yesterday's transactions by hand. We can look into importing data later.\n\nClick the PLUS button in the top right corner next to your email address. Then click \"New withdrawal\". You will see this screen:\n\n![Create transaction](/_media/e801d58e27d1f0975924.png)\n\nThere are a lot of options to fill in, but we're going to stick to the basics for now.\n\n1. Under \"Description\", fill what the transaction was for. Example: \"Groceries\", \"this month's rent\" or \"present for my mom\".\n2. Under \"Source account\", use the keyboard to type your bank account name and select your main bank account from the list.\n3. Under \"Destination account\", type the name of the store where the transaction took place. For example: \"Walmart\", \"Amazon\" or \"MacDonalds\".\n\nUnder date, you select yesterday's date using the dropdown. You can also enter the time if you wish.\n\nUnder amount, you enter the amount. The amount must always be positive, even though this is a withdrawal.\n\nWe won't use the other fields for now. Scroll down if necessary and press \"Submit\".\n\n\n## Check the transaction {#check-the-transaction}\n\n\nYou can find the transaction on your home screen on the right, or by browsing to Transactions > Withdrawals.\n\n![My first withdrawal](/_media/680e19ddcbc1e4819b0d.png)\n\n\n## Create more transactions {#create-more-transactions}\n\n\nJust keep pressing that \\(+\\) button to create more transactions. Keep the following rules in mind.\n\n1. New deposits need a new source account, the \"[revenue account](/references/firefly-iii/account-types/)\". To create it, just type the source of the money in the Source Account field. The account will be automatically created. For example, just type \"My job\" and the account will be created. The destination account must be your main asset account.\n2. Transfers between accounts can be recorded by making the source AND destination accounts point to one of your asset accounts.\n\nYou are free to add tags or set a category, but subscriptions, budgets and piggy banks need more work. We'll get to that later.\n\n\n## Validate balance {#validate-balance}\n\n\nBrowse to Accounts > Asset accounts. Here you should see your bank accounts and some extra's, with the correct balance.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\n- [How to organize transactions](/how-to/firefly-iii/finances/transactions/)\n- [How to manage budgets](/how-to/firefly-iii/finances/budgets/)\n- [More how to guides](/how-to/)\n",
      "documentId": "tutorials/finances/first-accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/first-accounts/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/subscription/index.md",
      "kind": "page",
      "title": "Manage a subscription",
      "description": "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\".",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/subscription/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/subscription/index.md",
      "file": "tutorials/finances/subscription/index.md",
      "searchText": "\n# Manage a subscription {#manage-a-subscription}\n\n\n\n\n> [!TIP]\n> I've not yet finished writing this tutorial. Some items may not be filled in yet. I apologize for the inconvenience. Please refer to the [support page](/explanation/support/) if you have questions.\n\n\n\nYou can use subscriptions to track regular income from your accounts to any third party. To read more about subscriptions, see also:\n\n- [An explanation about subscriptions](/explanation/financial-concepts/subscriptions/)\n- [How to manage subscriptions](/how-to/firefly-iii/finances/subscriptions/)\n\n\n## Create your first subscription {#create-your-first-subscription}\n\n\nIn 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\".\n\nIn either case, you see this screen:\n\n![My first subscription](/_media/aa83929c2192309ee123.png)\n\nFill in the name and the minimum and maximum amounts of the subscription. The actual amount of a transaction linked to this subscription is always allowed to be more or less, but Firefly III will use the average of these two amounts as the expected amount when calculating expected spending for each period.\n\nBe sure to indicate when you expect this subscription to arrive for the first time. If this subscription is already running you can also add a date in the past. The important thing is that Firefly III knows on which day of the period the subscription is supposed to arrive. On the next line, you indicate how often the subscription arrives. The default is \"monthly\" but you see a few options.\n\nTo set a subscription bi-weekly, or every 3 days, use the \"skip\"-field. For a bi-weekly subscription, fill in 1.\n\nThe optional fields on the right allow you to give the subscription an end date and an extension date. If you set up notifications according to [how to set up notifications](/how-to/firefly-iii/advanced/notifications/), Firefly III will warn you about the subscription's expiry/extension date. You can also add a group to your subscription. Any group that doesn't exist yet will be created.\n\n\n### Create a rule {#create-a-rule}\n\n\nIf you press \"Store new subscription\" you get redirected to the form to create a new rule. You can read about this on the page [how to manage rules](/how-to/firefly-iii/features/rules/). \n\nFor this tutorial, we will skip this step. In the left-hand menu, click Subscriptions again.\n\n\n## See it in the overview {#see-it-in-the-overview}\n\n\nIn the overview, you will see your just-created subscription. It will look something like this:\n\n![Subscriptions list](/_media/919d67cc1a84298a0cb0.png)\n\nIf you click it, you will see the details of the subscription:\n\n![Subscription details](/_media/e1e9eb7c2227c1be7a59.png)\n\nOn the home page the subscription is also visible:\n\n![Home page subscription info box](/_media/dc83543956e762aac51f.png)\n\n\n## Link a transaction {#link-a-transaction}\n\n\nNow, if you make a withdrawal you can select the subscription to be linked to the transaction. Note that this will not work for transfers or deposits. You can only link subscriptions to withdrawals.\n\n![Link transaction to subscription](/_media/3659bb0ea21cb7893cdf.png)\n\nNote that it doesn't matter if the amount is not right for the subscription (too much or too little). Firefly III will still link the subscription to the transaction. It's also okay to link transactions to a subscription that fall outside the subscription's schedule.\n\n\n## See subscriptions being paid {#see-subscriptions-being-paid}\n\n\nOn the subscriptions page, you can see that the transaction is linked to the subscription, and the subscription is now paid. You can also see the next expected payment date.\n\n![Subscriptions list - paid transaction](/_media/48bb31559dc20533bd93.png)\n\n![Subscription page - paid transactions](/_media/194aa0683aebc3f21262.png)\n\n\n## Look it up in reports {#look-it-up-in-reports}\n\n\nIf you go to the reports page, you can see the subscription in the \"default financial report\". The monthly overview features all subscriptions of that period and whether they were paid.\n\n\n![Default financial report - subscriptions report](/_media/bfb9f3c8cbd4c7fec7ec.png)",
      "documentId": "tutorials/finances/subscription",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/subscription/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/subscription/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/refund/index.md",
      "kind": "page",
      "title": "Process a refund",
      "description": "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?",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/refund/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/refund/index.md",
      "file": "tutorials/finances/refund/index.md",
      "searchText": "\n# Process a refund {#process-a-refund}\n\n\nHow you process refunds is a choice. Basically, you can:\n\n1. Make the original expense disappear\n2. Keep the original expense, use the money as \"income\"\n\nThis 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?\n\nFirefly III does not offer the option to automatically merge two a refund into the original transaction. It's also different whether you create your transactions manually, or if you use the data importer to do this for you.\n\n\n## What do I do with people who pay me back? {#what-do-i-do-with-people-who-pay-me-back}\n\n\nLet's say you have a budget for \"Going out\", worth 100. You go out with some friends, and you offer to pay the bill, expecting your friends to pay you back later. The total bill is 120 with your three friends, who owe you 90 in total. So although you spent € 120 (overspending your budget with € 20), your actual costs are a mere € 30. What to do?\n\nIt's important that Firefly III won't do anything. You can't correct your budget with income, so your budget will appear to have been overspent with € 20. But you can correct this yourself. How exactly is entirely up to you.\n\n1. You increase the budget with € 90 to a total of € 190. This means you still have € 70 to spend (€ 190 - € 120) but your budget is changed.\n2. You edit the expense, so it lists € 30 instead of € 120. This means you don't have to change the budget, but also means you ignore the deposits from your friends.\n\nIt's up to you what you do. _Personally_, I do nr. 2. It means that Firefly III shows me what I actually spent, and my own income isn't skewed by what people pay me back.\n\n\n## How do I handle (partial) refunds? {#how-do-i-handle-partial-refunds}\n\n\nYou may get a partial refund from a vendor. If you add this money as a deposit, the original transaction will not change. Your budgets will also still be affected. It's up to you to manage this, according to your preference. The expense account and revenue account cannot be merged. You cannot create a split transaction of different types (one withdrawal, one deposit).\n\n1. Update the original transaction to be the amount minus the refund. That way, it's like you never spent the money.\n2. Add a deposit for the refund, and increase your budget to match the new room for expenses you just created. It will still show up in reports as if you spent more than you did.\n\nGenerally, the first method is recommended when the vendor makes a mistake. The second one is recommended when you overspent.\n\n\n## What do I do with cashback actions? {#what-do-i-do-with-cashback-actions}\n\n\nWhen you buy a new 500 TV, and they give you a 50 cashback. What do you do?\n\n1. Register an 500 withdrawal for the TV and a 50 deposit for the cashback.\n2. Register just the withdrawal at 450.\n\nBoth options are valid. You can't merge these in one transaction. But less is more, and I suggest the second option. That way you have less transactions to manage and the price you actually paid for the television is reflected in the transaction.\n\nWhen you use the cashback to buy something else at a discount, apply the difference in the second transaction. So if you were able to buy a 90 blender for 40 with the cashback from the TV, make a withdrawal for 40.\n",
      "documentId": "tutorials/finances/refund",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/refund/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/refund/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/mortgage/index.md",
      "kind": "page",
      "title": "Manage your mortgage",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/mortgage/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/mortgage/index.md",
      "file": "tutorials/finances/mortgage/index.md",
      "searchText": "\n# Manage your mortgage {#manage-your-mortgage}\n\n\nThere 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.\n\n\n## Create a mortgage account {#create-a-mortgage-account}\n\n\nYour mortgage loans should be created as a liability account. You can do that on the Liabilities page. For more information, see [how to manage liabilities](/how-to/firefly-iii/finances/liabilities/).\n\n\n\n> [!TIP]\n> At this point it's optional but smart to buy a house to pay a mortgage on.\n\n\n\n\n## Paying your mortgage {#paying-your-mortgage}\n\n\nYou can pay off your mortgage in several ways. Here are the most used ones.\n\n\n### A mortgage payment which is entirely interest {#a-mortgage-payment-which-is-entirely-interest}\nTo manage a mortgage payment that is entirely interest, you have three options. \n\n1. Create a withdrawal from an asset account to your bank's expense account. This is useful when you pay the interest entirely out of your own pocket. The transaction will not be recorded under your mortgage but the amount due of your mortgage will also not decrease (or increase).\n2. Send the interest payment as a withdrawal from your asset account to your mortgage, and then create a second withdrawal from your mortgage to the bank. The difference with the previous method is that the transaction is *also* recorded under your mortgage account.\n3. Send the interest payment as a withdrawal directly from your mortgage to your bank. This essentially results in a higher \"amount due\", but you can always correct this later (as detailed in item 2).\n\nDepending on your own goals of tracking and granularity, you can either use a shared expense account for all interest payments (of all your liabilities) or create a unique expense account for this particular liability. You would be able to track this over time either way.\n\n\n### Mortgage payment is split partly interest and part principal {#mortgage-payment-is-split-partly-interest-and-part-principal}\n* Create two transactions, or a single split transaction.\n  * Interest is treated as above, from an asset account to an expense account.\n  * The principal amount (that will reduce your mortgage), from your asset account to your Mortgage Liability account.\n\n\n### Mortgage payment is only principal(extra payment to reduce mortgage) {#mortgage-payment-is-only-principalextra-payment-to-reduce-mortgage}\n* Create a transaction that goes from your asset account to your liability account.\n\n\n## Budgets and Categories {#budgets-and-categories}\n\n\nIt is your choice whether to have separate budgets/categories for interest/principle, or combined, or a mix. \n\nDepending on your choice, you can leverage the reports for insights over time. Personally, I use one budget for all mortgage transactions, but different categories to show my interest vs principle over time. \n\n\n## See the result {#see-the-result}\n\n\nOver time, you'll see your mortgage liability account balance decrease as you make principal payments. You can also generate reports to see how much you've paid in interest versus principal over any time period.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\n- [How to manage liabilities](/how-to/firefly-iii/finances/liabilities/)\n- [How to manage budgets](/how-to/firefly-iii/finances/budgets/)\n- [How to organize transactions](/how-to/firefly-iii/finances/transactions/)\n",
      "documentId": "tutorials/finances/mortgage",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/mortgage/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/mortgage/index.md"
        }
      ]
    },
    {
      "id": "tutorials/finances/currencies/index.md",
      "kind": "page",
      "title": "Manage multiple currencies",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/finances/currencies/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/currencies/index.md",
      "file": "tutorials/finances/currencies/index.md",
      "searchText": "\n# Manage multiple currencies {#manage-multiple-currencies}\n\n\nFirefly 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.\n\n\n## View available currencies {#view-available-currencies}\n\n\nGo to Options > Currencies in the left-hand menu. Here you can see all available and enabled currencies. By default, only one currency is enabled. Press the \"Enable\" button to enable a currency.\n\n\n\n\n## Add a custom currency {#add-a-custom-currency}\n\n\nTo add a currency click \"Create a new currency\". The form is simple enough. Use [a three-letter code from this list](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).\n\nThe number of decimals is almost always 2, but some cryptocurrencies require more decimals. The maximum is 12.\n\nThe symbol is what's used in most overviews and charts. If you have multiple currencies using the same symbol (for example the US and Australian dollar), you can choose to add an identifying letter: US$ and A$.\n\n(TODO add screenshot)\n\n\n## Create a multi-currency transaction {#create-a-multi-currency-transaction}\n\n\nWhen you create a new transaction, you have the option to add a foreign amount. The currencies that are enabled are options in the list. If you select a foreign currency, you must also enter the foreign amount.\n\n(TODO add screenshot)\n\n(TODO add screenshot of the result)\n\n\n## Create an asset account with another currency {#create-an-asset-account-with-another-currency}\n\n\nWhen you create an asset account, you can select the currency of the account. This is the currency that will be used for the account. You can only select currencies that are enabled.\n\n(TODO add screenshot)\n\n\n### Transfer between asset accounts in different currencies {#transfer-between-asset-accounts-in-different-currencies}\n\n\nWhen you transfer money between two asset accounts with different currencies, you must set the amount of the transfer in both currencies. The balances of each account will be updated accordingly:\n\n(TODO add screenshot)\n\n\n## Quirks {#quirks}\n\n\n(TODO chart example in FAQ)\n\n(TODO this is more of a how-to than a tutorial)\n",
      "documentId": "tutorials/finances/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/finances/currencies/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/finances/currencies/index.md"
        }
      ]
    },
    {
      "id": "tutorials/firefly-iii/importing-data/index.md",
      "kind": "page",
      "title": "Importing data",
      "description": "(TODO link to other tutorials)",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/importing-data/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/importing-data/index.md",
      "file": "tutorials/firefly-iii/importing-data/index.md",
      "searchText": "\n# Importing data {#importing-data}\n\n\n\n\n> [!TIP]\n> I've not yet finished writing this tutorial. Some items may not be filled in yet. I apologize for the inconvenience. Please refer to the [support page](/explanation/support/) if you have questions.\n\n\n\n\n# Introduction {#introduction}\n\n\n(TODO link to other tutorials)\n\nIn order to import transactions into Firefly III, you'll have to install the Firefly III Data Importer. This app connects to the [Firefly III API](/api/).\n\nFirefly III and the Data Importer are two different applications.\n\nThis data importer is a universal importer, which means it can import from any sources you can think of. And if it can't, well then drop me a line and make me add your favorite data source.\n\nThe data import supports a variety of sources:\n\n- You can import **CSV files** from *any* source: your bank, YNAB, Tiller or any other source of financial data.\n- You can import from your bank directly using a secure connection.\n- You can set it up to run daily or weekly to keep Firefly III up to date.\n\n\n## Other import tools {#other-import-tools}\n\n\nThe documentation for the Data Importer lists [other tools](/references/data-importer/third-party-tools/) that you can use to import data.\n\n\n## Custom importing {#custom-importing}\n\n\nIf none of these import methods support your bank or financial organisation, please check out the [API](/references/firefly-iii/api/).\n",
      "documentId": "tutorials/firefly-iii/importing-data",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/importing-data/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/importing-data/index.md"
        }
      ]
    },
    {
      "id": "tutorials/firefly-iii/exporting-data/index.md",
      "kind": "page",
      "title": "Exporting data",
      "description": "(TODO write tutorial structure and incorporate info below)",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/exporting-data/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/exporting-data/index.md",
      "file": "tutorials/firefly-iii/exporting-data/index.md",
      "searchText": "\n# Exporting data {#exporting-data}\n\n\n\n\n> [!TIP]\n> I've not yet finished writing this tutorial. Some items may not be filled in yet. I apologize for the inconvenience. Please refer to the [support page](/explanation/support/) if you have questions.\n\n\n\n(TODO write tutorial structure and incorporate info below)\n\nFirefly III lets you export transactions and other data to CSV files.\n\n\n\n> [!WARNING]\n> Don't use this feature to back up your data. Backup the database instead. You may not be able to restore everything when you try to import the generated files.\n\n\n\n\n## Basic export {#basic-export}\n\n\nGo to `/export` in your Firefly III installation, or follow the menu under \"import and export\".\n\nHere you'll find a button that you can use to export all of your transactions. This may take some time, and your installation may time out.\n\nIf you want more fine-grained control over the export, or if you want to export other files as well, please use the command line options.\n\n\n## Command line {#command-line}\n\n\nThe basic command for the command line is this: `php artisan firefly-iii:export-data`. Without a date or other options it won't do anything. Refer to the options below.\n\nWhat the file name will be, depends on what you export. The basic format is like called `yyyy_mm_dd_transactions.csv`.\n\nYou can use the following options to configure the export.\n\n* `--start=yyyy-mm-dd`. Start date of the export. This applies to transactions only.\n* `--end=yyyy-mm-dd`. Start date of the export. This applies to transactions only.\n* `--accounts=1,2,3,4`. Only include these asset accounts or liabilities in the export of transactions. Comma separated list of ID's. This applies to transactions only.\n* `--export_directory=./`. Where to store the files. Must be writeable. Defaults to `./` (the current directory).\n\nYou can set what to export using the following flags:\n\n* `--export-accounts`. Creates a separate file with all your accounts and some metadata.\n* `--export-budgets`. Creates a separate file with all your budgets and some metadata.\n* `--export-categories`. Creates a separate file with all your categories and some metadata.\n* `--export-tags`. Creates a separate file with all your tags and some metadata.\n* `--export-recurring`. Creates a separate file with all your recurring transactions and some metadata.\n* `--export-rules`. Creates a separate file with all your rules and some metadata.\n* `--export-subscriptions`. Creates a separate file with all your subscriptions and some metadata.\n* `--export-piggies`. Creates a separate file with all your piggy banks and some metadata.\n* `--export-transactions`. Creates a separate file with all your transactions and some metadata.\n\nIf you add none of these flags, Firefly III will export nothing.\n\nFirefly III does not have the functionality to import this data. If you need to back up or migrate your data, backup and restore your database directly.\n",
      "documentId": "tutorials/firefly-iii/exporting-data",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/exporting-data/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/firefly-iii/exporting-data/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/csv/index.md",
      "kind": "page",
      "title": "Import a basic CSV file",
      "description": "Browse to importer, select CSV, upload a CSV file.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/csv/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/csv/index.md",
      "file": "tutorials/data-importer/csv/index.md",
      "searchText": "\n# Import a basic CSV file {#import-a-basic-csv-file}\n\n\n\n\n> [!TIP]\n> I've not yet finished writing this tutorial. Some items may not be filled in yet. I apologize for the inconvenience. Please refer to the [support page](/explanation/support/) if you have questions.\n\n\n\n\n## Select a data source {#select-a-data-source}\n\n\n- Link to how to install the data importer\n\nBrowse to importer, select CSV, upload a CSV file.\n\n![Select import routine](/_media/ad7da28f0ad251d3a917.png \"Select import routine\")\n\n\n## Import a CSV file or a camt.053 file {#import-a-csv-file-or-a-camt053-file}\n\n\nYou have to upload the file you wish to import. \n\n\n\n> [!IMPORTANT]\n> **A note when importing CSV files**\n>\n> If the file contains any lines before the data starts, you must remove them manually. If there are extra headers (for example every 100 rows) you'll have to delete those too.\n\n\n\nThere may be a standard configuration file for your bank in **[this GitHub repository](https://github.com/firefly-iii/import-configurations)**. If not, it is OK to continue without a configuration file.\n\n![Upload CSV](/_media/915a46723f5261f76aad.png \"Upload CSV\")\n\n\n## Configure the import {#configure-the-import}\n\n\nThe options on this page are explained on the page [how to import a file](/how-to/data-importer/import/file/). The most important options are:\n\n- The delimiter (comma's, semicolons or something else)\n- Headers, yes or no?\n\n\n### Duplicate transaction detection {#duplicate-transaction-detection}\n\n\nFor now, select \"content-based duplicate detection\". You can learn [how duplicate detection works](/how-to/data-importer/import/duplicates/).\n\n\n## Column roles {#column-roles}\n\n\nYou have to tell the Firefly III data importer what each column means. The page looks something like this:\n\n![An example CSV file with 3 columns.](/_media/84ce38043aee7a966a3c.png)\n\nEach column must be given a role. You can of course, choose to ignore a column. These are the roles that you can choose from:\n\n\n## Map data {#map-data}\n\n\nIf you import data, you can \"map\" the data found to data already present in Firefly III. You can use this to map account names in the CSV or camt.053 file to account names already in Firefly III. If you do not map data, Firefly III will make one-on-one to existing or to be created data.\n\nTo read more about this, read the [how to map data](/how-to/data-importer/import/map-data/).\n\n\n## Import {#import}\n\n\nThe import process consists of two steps. First a conversion and data validation. Then, the data will actually be sent to Firefly III.\n\nPress \"Start Job\" to start the conversion and validation process. If this is successful, you can press \"Start Job\" after a few moments to import the data.\n\nEach step can run into plenty of errors. Most of them are documented in [this FAQ](/references/faq/data-importer/import/), but I'm pretty sure I missed a few. Please refer to the [support page](/explanation/support/) if you need help.\n",
      "documentId": "tutorials/data-importer/csv",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/csv/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/csv/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/camt/index.md",
      "kind": "page",
      "title": "Import a CAMT.05x file",
      "description": "Import a CAMT.05x file",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/camt/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/camt/index.md",
      "file": "tutorials/data-importer/camt/index.md",
      "searchText": "",
      "documentId": "tutorials/data-importer/camt",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/camt/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/camt/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/data-providers/index.md",
      "kind": "page",
      "title": "What are data providers?",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/index.md",
      "file": "tutorials/data-importer/data-providers/index.md",
      "searchText": "\n# What are data providers? {#what-are-data-providers}\n\n\nWhen 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](/tutorials/data-importer/csv/) and [CAMT.05x files](/tutorials/data-importer/camt/) which are provided by most (if not all) banks to import data into Firefly III.\n\n\n## But I want more automation! {#but-i-want-more-automation}\n\n\nYou're in luck! In the navigation (on most devices you will find this on the left side of your screen), you will find menu items for all currently supported data providers and how to use them to import data into Firefly III.\n\n\n\n> [!WARNING]\n> I have not finished all tutorials yet, my apologies for the wait.\n\n",
      "documentId": "tutorials/data-importer/data-providers",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/data-providers/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/basiq/index.md",
      "kind": "page",
      "title": "basiq.io",
      "description": "I have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/basiq/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/basiq/index.md",
      "file": "tutorials/data-importer/basiq/index.md",
      "searchText": "\n# basiq.io {#basiqio}\n\n\nI have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "documentId": "tutorials/data-importer/basiq",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/basiq/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/basiq/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/eb/index.md",
      "kind": "page",
      "title": "Enable Banking",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/eb/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/eb/index.md",
      "file": "tutorials/data-importer/eb/index.md",
      "searchText": "\n# Enable Banking {#enable-banking}\n\n\n[Enable Banking](https://enablebanking.com/) is a European open banking aggregator that connects to 2500+ banks\nacross 29 European countries using official PSD2 APIs. This tutorial guides you through setting up Enable Banking\nwith the Firefly III Data Importer.\n\nEnable Banking offers a **free restricted mode** that allows you to access your own bank accounts without a paid\nsubscription. In this mode, you can only access accounts that you have previously linked in the Enable Banking\nportal. This is perfect for personal finance management with Firefly III.\n\n\n\n> [!WARNING]\n> **Restricted Mode Limitations**\n>\n> In restricted mode, you will **only** be able to access bank accounts that you have explicitly linked in the\n> Enable Banking portal. If you skip the account linking step, no accounts will be returned during import.\n\n\n\n\n## Create an Enable Banking account {#create-an-enable-banking-account}\n\n\n1. Go to [enablebanking.com](https://enablebanking.com/) and click \"Get Started\"\n2. Fill in the registration form with your details\n3. Wait for a confirmation email from Enable Banking (this may take some time)\n4. Once you receive the email, follow the instructions to access your Enable Banking Control Panel\n\n\n## Create an application {#create-an-application}\n\n\nIn the Enable Banking Control Panel, you need to create an application that will be used to connect to your bank\naccounts.\n\n1. Navigate to \"API Applications\" in the top menu\n2. Fill the \"Add a new application\" form:\n    - **Environment**: Select \"Production\" (not Sandbox) if you want to access real bank data\n    - **Private key generation**: Keep the default option \"Generate in the browser (using SubtleCrypto) and export\n      private key\"\n    - **Application Name**: Give it a descriptive name like \"Firefly III Data Import\"\n    - **Allowed Redirect URLs**: Enter `https://<YOUR_DATA_IMPORTER_URL>/eb-callback`\n    - **Description**: A brief description of your application (e.g., \"Personal finance import\")\n    - **Email for data protection matters**: Your email address\n    - **Privacy Policy URL**: Enter your Data Importer root URL (e.g., `https://<YOUR_DATA_IMPORTER_URL>/`)\n    - **Terms of Service URL**: Enter your Data Importer root URL (e.g., `https://<YOUR_DATA_IMPORTER_URL>/`)\n\n\n\n> [!TIP]\n> **Privacy and Terms URLs**\n>\n> In Restricted mode, the Privacy Policy and Terms of Service URLs are not validated. You can use your Data\n> Importer's root URL as a placeholder.\n\n\n\n\n\n> [!NOTE]\n> **Redirect URL Requirements**\n>\n> **Production environment** requires HTTPS, but the **Sandbox environment** works with HTTP. Replace `<YOUR_DATA_IMPORTER_URL>` with your actual Data Importer URL, for example: `https://importer.example.com/eb-callback`. You can find your callback URL on the `/authenticate-flow/eb` page of your data importer. The URL does not have to be public.\n\n\n\n3. Upon submission, your browser will automatically download a **PEM file** containing your private key.\n   **Save this file securely**; you will need it later.\n4. Note your **Application ID** (also called Client ID); this is displayed in the Control Panel.\n\n![Create Application](/_media/e5a9f7814b8da7363270.png \"Create a new Enable Banking application\")\n\n\n## Link your bank accounts (required for free plan) {#link-your-bank-accounts-required-for-free-plan}\n\n\nThis is the most important step for using the free restricted mode.\n\n1. In your Enable Banking Control Panel, find your newly created application\n2. Click the \"Link accounts\" button\n3. Connect to your bank and authorize access to your accounts\n\n\n\n> [!CAUTION]\n> **Do Not Skip This Step**\n>\n> If you do not link your bank accounts in the Enable Banking portal **before** attempting to import, the Data\n> Importer will not receive any accounts. Enable Banking will NOT return bank accounts in restricted mode which\n> have not been previously authorized.\n\n\n\nAfter linking your accounts, your application will show as **\"Restricted\"** but **\"Active\"** in the Control Panel.\nThis is expected and indicates that the application is limited to pre-authorized accounts only, but you are good to go.\n\n![Link Accounts](/_media/08eff683ebec427bfe80.png \"Link your bank accounts\")\n\n\n## Configure the data importer {#configure-the-data-importer}\n\n\nYou have two options for providing your Enable Banking credentials to the Data Importer.\n\n\n### Option A: environment variables {#option-a-environment-variables}\n\n\nSet the following environment variables in your Data Importer configuration. Depending on your setup, you may need\nto edit `.importer.env` or configure them in Docker.\n\n```\n#\n# example content if your .importer.env\n#\nENABLE_BANKING_APP_ID=your_application_id_here\nENABLE_BANKING_PRIVATE_KEY=\"-----BEGIN PRIVATE KEY-----\\n.......your_private_key_contents_here.....\\n-----END PRIVATE KEY-----\"\n```\n\nTo get the PEM contents, open the downloaded PEM file with a text editor and copy the entire contents, including\nthe `BEGIN` and `END` lines. To make sure it works in your `.importer.env`, follow these instructions. You will end up with your key just like the example earlier\n\nFirst, remove ALL newlines from the private key, so it becomes one long line and two dividers. Do not add `\\n` or whatever. Make it one big continuous long string:\n\n```\n#\n# Intermediate step, this is not the final result.\n#\n-----BEGIN PRIVATE KEY-----\n......................................................................etc\n-----END PRIVATE KEY-----\n```\n\nThen, add `\\n`, two times. One **after** `-----BEGIN PRIVATE KEY-----` and one **before** `-----END PRIVATE KEY-----`. Also remove the actual enters. This should be the result:\n\n```\n#\n# Intermediate step, see how it is one line combines with 2x \\n now?\n#\n-----BEGIN PRIVATE KEY-----\\n................\\n-----END PRIVATE KEY-----\n```\n\nAdd this line to your environment variables. If you use the `.importer.env` file, **add \"quotes\" around it**.\n\n```\n#\n# See how the \"quotes\" and newlines are combined to create a key. Instead of the dots it's your key of course.\n#\nENABLE_BANKING_PRIVATE_KEY=\"-----BEGIN PRIVATE KEY-----\\n................\\n-----END PRIVATE KEY-----\"\n```\n\nLet me know if this works!\n\n\n\n\n> [!TIP]\n> **Multi-line environment variable**\n>\n> If your environment does not support multi-line values, you can often use `\\n` to represent newlines, or store\n> the PEM file path instead and mount it as a volume in Docker.\n\n\n\n\n### Option B: Enter credentials in the UI {#option-b-enter-credentials-in-the-ui}\n\n\nWhen you select Enable Banking as the import method in the Data Importer, you can enter the Client ID and upload\nthe PEM file directly. This works but is less convenient as you need to provide these each time.\n\n![Enter Credentials](/_media/a8f503055a627e4cd0a1.png \"Enter Enable Banking credentials\")\n\n\n## Start the import {#start-the-import}\n\n\n1. Open the Data Importer and authenticate with Firefly III if prompted\n2. Select **Enable Banking** as the import method\n3. If credentials are not set via environment variables, enter your Client ID and upload the PEM file\n4. Upload a configuration file if you have one from a previous import (optional)\n\n![Select Enable Banking](/_media/1bdf15114395f247a780.png \"Select Enable Banking as import method\")\n\n\n## Select country and bank {#select-country-and-bank}\n\n\n1. Select your country from the dropdown list\n2. Select your bank from the list of available institutions\n\nUnlike other providers, Enable Banking only displays banks that are available for the selected country. If your bank\nis not listed, it may not be supported by Enable Banking in your region.\n\n![Select Bank](/_media/cbccfb604939ce337bde.png \"Select your country and bank\")\n\n\n## Authorize access {#authorize-access}\n\n\nAfter selecting your bank, you will be redirected through two authorization steps:\n\n1. **Enable Banking authorization**: Review and accept the terms\n2. **Bank authorization**: Log in to your bank and authorize the data access\n\nAfter completing both authorizations, you will be redirected back to the Data Importer.\n\n\n\n> [!WARNING]\n> **No Accounts Returned?**\n>\n> If you are redirected back but no bank accounts appear, this is because the accounts were not pre-authorized\n> in Step 3. Go back to the Enable Banking portal and link your accounts first.\n\n\n\n\n## Configure the import {#configure-the-import}\n\n\n\n### Select accounts {#select-accounts}\n\n\nChoose which bank accounts to import from and map them to your Firefly III asset accounts. If an IBAN matches an\nexisting account, the selection may be automatic.\n\n![Account Selection](/_media/bc4f516780a907662d29.png \"Select accounts to import\")\n\n\n### Date range {#date-range}\n\n\nYou can limit the import to a specific date range:\n\n- **Import everything**: Fetch all available transaction history\n- **Go back a number of days/weeks/months**: Only import recent transactions\n- **Select a specific range**: Define exact start and end dates\n\n\n### Import options {#import-options}\n\n\n- **Rules**: Enable this to apply your Firefly III rules to imported transactions\n- **Import tag**: Add a tag to group all transactions from this import\n- **Duplicate detection**: Choose how to handle potential duplicate transactions (content-based detection is\n  recommended)\n\n\n## Map data (Optional) {#map-data-optional}\n\n\nIf you enabled data mapping, you can connect the merchants and payees from your transactions to existing accounts\nin Firefly III. This is useful when:\n\n- You already have expense accounts set up in Firefly III\n- You have transfers between your own accounts that should be linked correctly\n\n\n## Submit to Firefly III {#submit-to-firefly-iii}\n\n\nClick \"Start Job\" to submit the transactions to Firefly III. The import process will run, and you will see a\nsummary when complete.\n\n![Submit Import](/_media/154c86ff3363b999f782.png \"Submit to Firefly III\")\n\nOnce complete, save your configuration file for future imports.\n\n\n## Troubleshooting {#troubleshooting}\n\n\n\n### No accounts are returned after bank authorization {#no-accounts-are-returned-after-bank-authorization}\n\n\nThis is the most common issue. Make sure you have linked your bank accounts in the Enable Banking portal (Step 3)\nbefore attempting to import. In restricted mode, only pre-authorized accounts are accessible.\n\n\n### Authorization fails or times out {#authorization-fails-or-times-out}\n\n\n- Verify your redirect URL is correctly configured in the Enable Banking portal\n- Ensure you are using HTTPS for production environments\n- Check that your PEM file is valid and matches your application\n\n\n### Invalid credentials error {#invalid-credentials-error}\n\n\n- Double-check your Client ID matches the one in the Enable Banking portal\n- Verify the PEM file contents are complete, including the header and footer lines\n- If using environment variables, ensure there are no extra spaces or encoding issues\n\n\n## References {#references}\n\n\nFor more information about Enable Banking:\n\n- [Enable Banking Documentation](https://enablebanking.com/docs/)\n- [Quick Start Guide](https://enablebanking.com/docs/api/quick-start/)\n- [FAQ](https://enablebanking.com/docs/faq/)\n\nCommunity discussions about the free \"own accounts\" plan:\n\n- [Reddit: Free API access to current/cards accounts data](https://www.reddit.com/r/eupersonalfinance/comments/k4ny3j/free_api_access_to_currrent_cards_accounts_data/)\n- [Reddit: Using Enable Banking with Revolut](https://www.reddit.com/r/Revolut/comments/1b3atd4/comment/kvggxfc/)\n",
      "documentId": "tutorials/data-importer/eb",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/eb/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/eb/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/fints/index.md",
      "kind": "page",
      "title": "FinTS",
      "description": "I have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/fints/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/fints/index.md",
      "file": "tutorials/data-importer/fints/index.md",
      "searchText": "\n# FinTS {#fints}\n\n\nI have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "documentId": "tutorials/data-importer/fints",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/fints/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/fints/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/gocardless/index.md",
      "kind": "page",
      "title": "Import from GoCardless",
      "description": "My apologies, in this screenshot it is still called \"Nordigen\".",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/gocardless/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/gocardless/index.md",
      "file": "tutorials/data-importer/gocardless/index.md",
      "searchText": "\n# Import from GoCardless {#import-from-gocardless}\n\n\n\n\n> [!NOTE]\n> GoCardless is \"shifting away\" from their Bank Account Data products (aka the service you need for this to work). These instructions are only here for users who still have access to their GoCardless account.\n\n\n\n\n## Select GoCardless {#select-gocardless}\n\n\nMy apologies, in this screenshot it is still called \"Nordigen\".\n\n![Select import routine](/_media/9b80c91602d18c50e7d0.png \"Nordigen is called GoCardless nowadays\")\n\n\n## Import from GoCardless {#import-from-gocardless_1}\n\n\nIf you import from GoCardless, you can also optionally upload a GoCardless configuration file. Also, you may have to enter your GoCardless ID and GoCardless Key, if they are not part of the data importer's environment variables.\n\nRead the page about [the data importer](/explanation/data-importer/introduction/) for more information about GoCardless.\n\n![GoCardless identifiers](/_media/5adb678c5e469b4c5461.png \"GoCardless identifiers\")\n\nAfter these settings, you must select your country and your bank of choice.\n\n![GoCardless bank selection](/_media/6db20d77c4ff570d1318.png \"GoCardless bank selection\")\n\nIf you continue, you will end up at the configuration screen.\n\n\n# Configure the import {#configure-the-import}\n\n\nAfter uploading a file, you'll be presented with a list of options. Some options are specific to a way of importing, like CSV or camt.053 files, GoCardless or Spectre. We start from the top and go down the page.\n\n\n## GoCardless import options {#gocardless-import-options}\n\n\nFor GoCardless you must first select the accounts to import from, and indicate in which account the data must be imported.\n\nYour selection may be limited: if the IBAN matches you have no choice. If the currency matches, only accounts with that currency can be selected.\n\n![Account selection](/_media/7a9183ce7656e7c57c9e.png \"Account selection\")\n\n\n## Import options {#import-options}\n\n\n\n### Default import account {#default-import-account}\n\n\nSelect the asset account you want to link transactions to, if your import doesn't have enough meta-data to determine this. This is some time useful when files just list the transactions and the destination, nothing more.\n\n\n### Rules {#rules}\n\n\nSelect this if you want Firefly III to apply your rules to the import. It is useful to run your rules after the import, so the transactions are cleaned up.\n\n\n### Import tag {#import-tag}\n\n\nWhen you check this the data importer will add a tag to each imported transaction denoting the import; this groups your import under a tag.\n\n\n\n> [!NOTE]\n> **Rules**\n>\n> If you have rules that remove all tags from a transaction, they will *not* work when you use this option. The tag will always be added. This is not because the data importer uses some magic trick. The tag is added *after* the transaction is created.\n\n\n\n\n### Custom import tag {#custom-import-tag}\n\n\nYou can set a custom import tag if you do not like the default one. To learn more about the possibilities, read the [FAQ on custom import tags](/how-to/data-importer/advanced/custom-import-tag/).\n\n\n### Date range {#date-range}\n\n\nFor GoCardless imports, you can select a date range, limiting the import. Options are as follows:\n\n- Import everything.\n- Go back a number of days, weeks, months or years.\n- Select a specific range to import from.\n\n\n## Duplicate transaction detection {#duplicate-transaction-detection}\n\n\nCheckout the [FAQ on duplicate transactions](/how-to/data-importer/import/duplicates/) and the FAQ on re-importing transactions for more information.\n\n\n\n> [!IMPORTANT]\n> **Duplicate detection**\n>\n> If you're unsure about what setting to use, use content-based duplicate detection.\n\n\n\n\n## Other options {#other-options}\n\n\nIf you want to, check the \"skip form\" button, so you don't have to go through these options each time you start an import.\n\n",
      "documentId": "tutorials/data-importer/gocardless",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/gocardless/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/gocardless/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/sophtron/index.md",
      "kind": "page",
      "title": "Sophtron",
      "description": "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 to you free of charge for personal, non-commercial use under this agreement. Although there are no usage limitations, a fair use policy is implemented.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/sophtron/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/sophtron/index.md",
      "file": "tutorials/data-importer/sophtron/index.md",
      "searchText": "\n# Sophtron {#sophtron}\n\n\nSophtron 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](https://sophtron.com/developerAgreement). The Sophtron API is available to you free of charge for personal, non-commercial use under this agreement. Although there are no usage limitations, a fair use policy is implemented.\n\n\n## Registration at Sophtron {#registration-at-sophtron}\n\n\nTo use Sophtron, register a new account [on their website](https://sophtron.com/account/register). Make sure you read and understand their user / developer agreement.\n\n\n## Collect access key and user ID {#collect-access-key-and-user-id}\n\n\nOnce registered and logged in, go to [your API settings](https://sophtron.com/manage/developer) and write down or copy/paste your User ID and Access Key:\n\n![Sophtron get keys](/_media/260f1b6a4d8268fb272b.png \"Sophtron user ID and access key\")\n\n\n## Register your bank {#register-your-bank}\n\n\nSurf to the [widget demo](https://sophtron.com/widgets-demo) and find your financial institution. Use the auto-complete box to find it. In the example in the screenshots ahead, I am connecting to the \"test\"-bank of Sophtron.\n\n![Sophtron all institutions](/_media/c81a55c6060979d088b6.png \"Sophtron select institution\")\n\n![Sophtron selected institutions](/_media/f778fbb984d91cc4cbf4.png \"Sophtron select institution\")\n\nProceed with the registration and follow the instructions. This is different for each bank.\n\n\n## Connect the dots in the Firefly III data importer {#connect-the-dots-in-the-firefly-iii-data-importer}\n\n\nYou can do two things.\n\n1. Enter your User ID and Access Key as environment variables: `SOPHTRON_USER_ID` and `SOPHTRON_ACCESS_KEY`. You can find them in your `.env` file, or add them to your Docker configuration.\n2. You can enter them manually when you click Sophotron in the next step.\n\nEither way, when you click \"Sophtron\" on the home page of the Firefly III data importer, you should either get the question about your User ID and Access Key, or you can continue to the upload.\n\n![Select Sophtron](/_media/f2dbffca93fa87e8ae80.png \"Select Sophtron\")\n\n\n### Upload a configuration file {#upload-a-configuration-file}\n\n\nIf you have a configuration file you can upload it now. If you have no idea what it is, just press Next.\n\n\n### Select the bank accounts to import from {#select-the-bank-accounts-to-import-from}\n\n\nAfter some reloading, the data importer will show you the configuration screen. The import can be fine-tuned. Most options are self-explanatory. Some are special:\n\n\n### Select accounts {#select-accounts}\n\n\nOn the Configuration page, you can select which accounts to import from, and into which Firefly III account the data must be imported. You can also tell the data importer to create new asset accounts, if they are not yet present.\n\n![Sophtron account selection](/_media/2f1177d8a1daf321aa3a.png \"Sophtron account selection\")\n\n\n### Date range {#date-range}\n\n\nYou can tell the data importer to go back only a limited period of time. This is useful if you have already imported data before, and only want to import recent data.\n\n![Sophtron date range](/_media/76ea1d2443ec43bf979e.png \"Select a range to import\")\n\n\n### Map data to Firefly III data {#map-data-to-firefly-iii-data}\n\n\nOptionally, select this option to map data to Firefly III data. What this does is explained in the next step.\n\n![Sophtron map data option](/_media/a1bf81a93d6463e6516c.png \"Select a range to import\")\n\nFinally, press \"Submit ->\" to continue.\n\n\n## Converting data {#converting-data}\n\n\nThis step will convert Sophtron data to Firefly III data. It will take a moment to run. Press \"Start Job ->\" and wait.\n\n![Sophtron map data option](/_media/a1bf81a93d6463e6516c.png \"Map data\")\n\n\n## Map data to existing accounts {#map-data-to-existing-accounts}\n\n\nThe data importer can connect the destinations of your expenses (or the source of income) to accounts in Firefly III. This is useful when you already have account data present in Firefly III, and doubly so when you have a savings account you want to be linked correctly.\n\n![Sophtron map data to accounts](/_media/2a3b17b6651141771b83.png \"Map data to existing accounts\")\n\nWhat you see here:\n\n1. The \"Opposing account (name)\" is Firefly III's name for the merchant, the payee or the other party in a transaction.\n2. In the \"Field value\" below, you see all possible names Firefly III has found during the import.\n3. In the \"Mapped to\" drop down, you can select which Firefly III account this opposing account must be linked to.\n\nIf you select nothing, which is the default option, Firefly III will create a new account for this opposing account or find an existing one to use.\n\nPress \"Submit ->\" to continue.\n\n\n## Submit to Firefly III {#submit-to-firefly-iii}\n\n\nFinally, you can submit the data to Firefly III. Press \"Start Job ->\" to continue.\n\n![Sophtron submit to Firefly III](/_media/367143b525bda978a220.png \"Submit to Firefly III\")\n\nOnce this process is complete, the data is imported. You can save the configuration file for later use. Congrats!",
      "documentId": "tutorials/data-importer/sophtron",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/sophtron/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/sophtron/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/lunchflow/index.md",
      "kind": "page",
      "title": "Lunch Flow",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/lunchflow/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/lunchflow/index.md",
      "file": "tutorials/data-importer/lunchflow/index.md",
      "searchText": "\n# Lunch Flow {#lunch-flow}\n\n\n[Lunch Flow](https://www.lunchflow.app/) 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.\n\n\n## Create a connection {#create-a-connection}\n\n\nIn your dashboard, under \"Connections\", click \"New Connection\" and follow the instruction to connect to your bank. You can repeat this process for multiple banks if you want.\n\n![Create Connection](/_media/6807f28e78f10ddf6cdd.png \"Create a new connection\")\n\n\n### Customize the connection {#customize-the-connection}\n\n\nOn the page of your new connection, open the dropdown that says \"X Accounts\". Under the tabs \"Details\", \"Merchant\", \"Description\" and \"Balances\" you can set various options that will reflect in Firefly III. Adjust them to your liking, but make sure that the \"Description\" value contains something. I suggest \"Remittance Information Unstructured\".\n\n\n\n> [!NOTE]\n> The \"Description\" field ends up in the transaction description in Firefly III, and if you leave it empty, all transactions end up as \"(no description)\", which is not very useful.\n\n\n\n\n\n## Create an API key {#create-an-api-key}\n\n\nNext, go to \"Destinations\" and click \"Add Destination\". Select \"API\" as the destination type. Give your new destination the name \"Firefly III\".\n\nOnce created, click Configure on the created destination. You need the \"API Key\". Copy it using the button.\n\n![Create API Key](/_media/4eb0be561f1a242c5b45.png \"Create an API Key\")\n\n\n## Configure the data importer {#configure-the-data-importer}\n\n\nIn order to make the data importer work with Lunch Flow you can do two things.\n\n\n### Set the API key as an environment variable {#set-the-api-key-as-an-environment-variable}\n\n\nSet the following environment variable. It depends a little bit on how you run the data importer how you must do this. You may have to edit `.importer.env` or set it in your Docker configuration.\n\n```\nLUNCH_FLOW_API_KEY=your_api_key_here\n```\n\n\n### Enter the API key in the UI {#enter-the-api-key-in-the-ui}\n\n\nIf you open the data importer and select Lunch Flow as the import method, you can enter the API key in the UI. This works but is not recommended, because you have to enter it every time.\n\n![Enter API Key](/_media/c7b8044234a2188c2d87.png)\n\n\n## Upload a configuration file {#upload-a-configuration-file}\n\n\nSince this is the first time you're connected to Lunch Flow, you can skip this step.\n\n\n## Configure the import {#configure-the-import}\n\n\nThe import can be fine-tuned. Most options are self-explanatory. Some are special:\n\n\n### Select accounts {#select-accounts}\n\n\nOn the Configuration page, you can select which accounts to import from, and into which Firefly III account the data must be imported. You can also tell the data importer to create new asset accounts, if they are not yet present.\n\n![Lunch Flow account selection](/_media/9cb84cdbc5b64fb1a264.png \"Lunch Flow account selection\")\n\n\n### Date range {#date-range}\n\n\nYou can tell the data importer to go back only a limited period of time. This is useful if you have already imported data before, and only want to import recent data.\n\n![Lunch Flow date range](/_media/76ea1d2443ec43bf979e.png \"Select a range to import\")\n\n\n### Map data to Firefly III data {#map-data-to-firefly-iii-data}\n\n\nOptionally, select this option to map data to Firefly III data. What this does is explained in the next step.\n\n![Lunch Flow map data option](/_media/a1bf81a93d6463e6516c.png \"Select a range to import\")\n\nFinally, press \"Submit ->\" to continue.\n\n\n## Converting data {#converting-data}\n\n\nThis step will convert Lunch Flow data to Firefly III data. It will take a moment to run. Press \"Start Job ->\" and wait.\n\n![Lunch Flow convert data](/_media/a1bf81a93d6463e6516c.png \"Convert data\")\n\n\n## Map data to existing accounts {#map-data-to-existing-accounts}\n\n\nThe data importer can connect the destinations of your expenses (or the source of income) to accounts in Firefly III. This is useful when you already have account data present in Firefly III, and doubly so when you have a savings account you want to be linked correctly.\n\n![Lunch Flow map data to accounts](/_media/2a3b17b6651141771b83.png \"Map data to existing accounts\")\n\nWhat you see here:\n\n1. The \"Opposing account (name)\" is Firefly III's name for the merchant, the payee or the other party in a transaction.\n2. In the \"Field value\" below, you see all possible names Firefly III has found during the import.\n3. In the \"Mapped to\" drop down, you can select which Firefly III account this opposing account must be linked to.\n\nIf you select nothing, which is the default option, Firefly III will create a new account for this opposing account or find an existing one to use.\n\nPress \"Submit ->\" to continue.\n\n\n## Submit to Firefly III {#submit-to-firefly-iii}\n\n\nFinally, you can submit the data to Firefly III. Press \"Start Job ->\" to continue.\n\n![Lunch Flow submit to Firefly III](/_media/367143b525bda978a220.png \"Submit to Firefly III\")\n\nOnce this process is complete, the data is imported. You can save the configuration file for later use. Congrats!\n\n",
      "documentId": "tutorials/data-importer/lunchflow",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/lunchflow/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/lunchflow/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/obg/index.md",
      "kind": "page",
      "title": "Open Banking Data (HBCI)",
      "description": "I have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/obg/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/obg/index.md",
      "file": "tutorials/data-importer/obg/index.md",
      "searchText": "\n# Open Banking Data (HBCI) {#open-banking-data-hbci}\n\n\nI have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "documentId": "tutorials/data-importer/obg",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/obg/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/obg/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/simplefin/index.md",
      "kind": "page",
      "title": "SimpleFIN imports using the data importer",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/simplefin/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/simplefin/index.md",
      "file": "tutorials/data-importer/simplefin/index.md",
      "searchText": "\n# SimpleFIN imports using the data importer {#simplefin-imports-using-the-data-importer}\n\n\n\n## Introduction {#introduction}\n\n\nSimpleFIN 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](https://www.simplefin.org/).\n\n\n## Configuring the importer {#configuring-the-importer}\n\n\n![Configuration](/_media/36cf98af89d4187887f8.png)\n\nIn the UI, enter the connection details from your bank. If you have set the necessary environment variables, the data importer will automatically use these values. If you have not set the environment variables, the data importer will ask you for the connection details.\n\nEnvironment variables are set in the `.env` file, or as Docker environment variables. The data importer will use the following environment variables:\n\n* `SIMPLEFIN_TOKEN`: Your SimpleFIN API token.\n\n\n## Select the accounts {#select-the-accounts}\n\n\n![Configuration](/_media/a7fc8ca6536443604dba.png)\n\nSelect the accounts you wish to import data from. If they do not exist yet, you can have them created for you.\n\n\n## Configure the import {#configure-the-import}\n\n\n![Configuration](/_media/6c84005e5d726557bd9d.png)\n\nAny other options can be set at your leisure.\n\n\n## Import the data {#import-the-data}\n\n\nYou can click through the rest of the import process. The data importer will process your data and import it into Firefly III.\n",
      "documentId": "tutorials/data-importer/simplefin",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/simplefin/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/simplefin/index.md"
        }
      ]
    },
    {
      "id": "tutorials/data-importer/teller/index.md",
      "kind": "page",
      "title": "teller.io",
      "description": "I have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/teller/",
      "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/teller/index.md",
      "file": "tutorials/data-importer/teller/index.md",
      "searchText": "\n# teller.io {#tellerio}\n\n\nI have not yet finished the integration for this data provider. Once I have, the tutorial will follow.",
      "documentId": "tutorials/data-importer/teller",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/tutorials/data-importer/teller/",
          "markdown": "https://sourcey-firefly.pages.dev/tutorials/data-importer/teller/index.md"
        }
      ]
    },
    {
      "id": "how-to/index.md",
      "kind": "page",
      "title": "How-to guides",
      "description": "These how-to guides will show you how to do things. The guides are goal oriented and will get you to a specific point.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/index.md",
      "file": "how-to/index.md",
      "searchText": "\n# How-to guides {#how-to-guides}\n\n\nThese how-to guides will show you how to do things. The guides are goal oriented and will get you to a specific point.\n\nPopular examples:\n\n1. How to [install Firefly III](/how-to/firefly-iii/installation/docker/)?\n2. How to set up [email notifications](/how-to/firefly-iii/advanced/notifications/)?\n3. How to [configure GoCardless](/how-to/data-importer/how-to-configure/)?\n\nThe menu on the left should guide your through the guides (hah). \n\n\n## Missing something? {#missing-something}\n\n\n1. You're missing a specific how-to guide, and you wish to write it\n2. You don't want to write it, but you still miss a specific how-to guide\n3. You spot inaccuracies, terrible grammar or spelling mistakes\n\nPlease open an [issue on GitHub](https://github.com/firefly-iii/firefly-iii/issues/new?assignees=&labels=&projects=&template=fr.yml). Your contributions are appreciated.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nCheck out the [support page](/explanation/support/).\n",
      "documentId": "how-to",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/index.md"
        }
      ]
    },
    {
      "id": "how-to/general/debug/index.md",
      "kind": "page",
      "title": "How to debug Firefly III?",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/general/debug/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/general/debug/index.md",
      "file": "how-to/general/debug/index.md",
      "searchText": "\n# How to debug Firefly III? {#how-to-debug-firefly-iii}\n\n\nIf 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.\n\n\n## How do I enable debug mode? {#how-do-i-enable-debug-mode}\n\n\n\n### Firefly III {#firefly-iii}\n\n\n\n#### Self-managed {#self-managed}\n\n\nWhen you host Firefly III yourself, open your `.env` file and find these lines:\n\n* Line that starts with `APP_DEBUG`. Change it to `APP_DEBUG=true`\n* Line that starts with `APP_LOG_LEVEL`. Change it to `APP_LOG_LEVEL=debug`\n* Line that starts with `LOG_CHANNEL`. Change it to `LOG_CHANNEL=stack`\n\nGo to the map `/firefly-iii/storage/logs`. Delete all files _except_ `.gitignore`.\n\nThis will enable debug logging and debug mode.\n\n\n#### Docker {#docker}\n\n\nWhen you're using Docker, restart your container with the following parameters:\n\n```text\n-e APP_DEBUG=true -e APP_LOG_LEVEL=debug -e LOG_CHANNEL=stack\n```\n\n\n### Data Importer {#data-importer}\n\n\n\n#### Self-managed {#self-managed_1}\n\n\nWhen you host the data importer yourself, open your `.env` file and find these lines:\n\n* Line that starts with `APP_DEBUG`. Change it to `APP_DEBUG=true`\n* Line that starts with `LOG_LEVEL`. Change it to `LOG_LEVEL=debug` if not already so\n* Line that starts with `LOG_CHANNEL`. Change it to `LOG_CHANNEL=stack`\n\nGo to the map `/data-importer/storage/logs`. Delete all files _except_ `.gitignore`.\n\nThis will enable debug logging and debug mode.\n\n\n#### Docker {#docker_1}\n\n\nWhen you're using Docker, restart your container with the following parameters:\n\n```text\n-e APP_DEBUG=true -e LOG_LEVEL=debug -e LOG_CHANNEL=stack\n```\n\nThis will enable debug logging and debug mode.\n\n\n## Where do I find the logs? {#where-do-i-find-the-logs}\n\n\n\n### Self-managed {#self-managed_2}\n\n\nCheck the folder `storage/logs` for a daily stream of log files.\n\n\n### Docker {#docker_2}\n\n\nRun the following command to \"tail\" the logs and see what's happening:\n\n```bash\ndocker container logs -f CONTAINER\n```\n\nThe `CONTAINER` variable can be different for everybody, but in a lot of cases it's either `firefly-iii-app-1` or `data-importer-1`.\n\n\n## How can I safely submit debug information? {#how-can-i-safely-submit-debug-information}\n\n\nA lot of data files contain private information. You should **never** share these files on GitHub. They are very hard to remove.\n\n\n\n> [!WARNING]\n> **Uploading files to GitHub**\n>\n> Do not upload CSV files or CAMT.053 to GitHub directly without censoring them first.\n\n\n\nUpload as few lines or blocks of data as is necessary to reproduce the error. Removing private information from the remaining data consists of (your choice):\n\n- Replace names with fake names;\n- Replace IBANs with [fake IBANs](https://fakeiban.org/);\n- Replace amounts with fake amounts\n\n\n\n> [!NOTE]\n> **Consistency is important**\n>\n> Try to remove as little data as you dare. Try to replace data consistently, always replacing IBAN \"ABC\" for the same (fake) IBAN for example.\n\n\n\nYou may always send your data file to me personally at [james@firefly-iii.org](mailto:james@firefly-iii.org). That leaks your personal data to a single person at least. I cannot guarantee nobody will ever hack me, but your files will be removed once the issue is closed.\n",
      "documentId": "how-to/general/debug",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/general/debug/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/general/debug/index.md"
        }
      ]
    },
    {
      "id": "how-to/general/report-security-issues/index.md",
      "kind": "page",
      "title": "How to report security issues",
      "description": "The latest instructions are in the security policy. Please follow those instructions closely.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/general/report-security-issues/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/general/report-security-issues/index.md",
      "file": "how-to/general/report-security-issues/index.md",
      "searchText": "\n# How to report security issues {#how-to-report-security-issues}\n\n\nThe latest instructions are in [the security policy](https://github.com/firefly-iii/firefly-iii/security). Please follow those instructions closely.\n\nEach installation comes with a security.txt file in the `.well-known/security.txt`. The [demo site as well](https://demo.firefly-iii.org/.well-known/security.txt).\n\n\n## Bounty program {#bounty-program}\n\n\nFirefly III has no bounty program. I have no money to pay you if you find anything.\n",
      "documentId": "how-to/general/report-security-issues",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/general/report-security-issues/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/general/report-security-issues/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/installation/docker/index.md",
      "kind": "page",
      "title": "How to install Firefly III using Docker",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/docker/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/docker/index.md",
      "file": "how-to/firefly-iii/installation/docker/index.md",
      "searchText": "\n# How to install Firefly III using Docker {#how-to-install-firefly-iii-using-docker}\n\n\nFirefly 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.\n\nThe easiest way to install Firefly III is using \"Docker compose\", which is a Docker tool that allows you to define and run multi-container Docker applications. With Docker compose, you use a YAML file to configure your application's services. Then, with a single command, you create and start all the services from your configuration.\n\nThe YAML file and all necessary configuration are provided online for your convenience.\n\nIf you have questions, please refer to [the Docker FAQ](/references/faq/docker/) or contact me using the instructions from the [support page](/explanation/support/).\n\n\n## Docker Compose {#docker-compose}\n\n\nDownload [the Docker Compose file](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose.yml) and place it somewhere convenient. To include the Data Importer in your installation, please read [how to install the data importer](/how-to/data-importer/installation/docker/).\n\nGrab the raw file, and don't copy-paste the text from your browser. The spaces in the file are very important. So use \"Save As\".\n\n\n### Download configuration files {#download-configuration-files}\n\n\nThere are two configuration files you need to run this Docker Compose file. Download all files and save them in the same folder as the Docker Compose file.\n\n- The first file contains Firefly III variables and can be downloaded from [the Firefly III repository](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example). Save it as a new file called `.env`.\n- The second file contains the database variables and can be downloaded from [the Docker repository](https://raw.githubusercontent.com/firefly-iii/docker/main/database.env). Save it as a new file called `.db.env`.\n\nIt is **important** that you rename the file as instructed here. You can see in the Docker compose file why this is. There is a reference to it: `env_file:`. If you don't name it as it is in the Docker Compose file, you must edit the Docker compose file to match the file names.\n\nInstructions:\n\n1. Change `DB_PASSWORD` in `.env` to something else. Pick a nice password.\n2. Change `MYSQL_PASSWORD` in `.db.env` to the SAME value\n\n\n\n> [!NOTE]\n> Change the password FIRST. If you change the password *after* you run Firefly III, it will complain about having no access because the password has been stored in  the database volume.\n\n\n\n\n#### Change to PostgreSQL {#change-to-postgresql}\n\n\nUsers running `arm/v7` (some Raspberry Pi users) may have to switch to PostgreSQL, because reliable containers running MariaDB and MySQL are not available for these platforms. To do this, change the following lines in the `.env` file.\n\n```text\nDB_CONNECTION=pgsql\nDB_HOST=db\nDB_PORT=5432\n```\nAlso change variable names in `.db.env` file from MYSQL\\_\\* to POSTGRES\\_\\*. MYSQL_RANDOM_ROOT_PASSWORD can be removed.\n\nChange the `docker-compose.yml` file to point to `postgres` instead of `mariadb:lts`.\n\nThen, change the mount point of the database under volumes (`firefly_iii_db`) to `/var/lib/postgresql`.\n\n\n\n> [!NOTE]\n> Pointing the image to `postgres` will install PostgreSQL-18. If you wish to use a lower version, ensure the mount point of the volumes (`firefly_iii_db`) is `/var/lib/postgresql/data`.\n\n\n\n\n### Start the container {#start-the-container}\n\n\nRun the following command in the directory where both `docker-compose.yml` and all configuration files are present.\n\n```bash\ndocker compose -f docker-compose.yml up -d --pull=always\n```\n\nYou can follow the progress of the installation by running this command:\n\n```text\ndocker compose -f docker-compose.yml logs -f\n```\n\nWhen the installation is done, Firefly III will thank you for installing it. Once you see this message, you can visit Firefly III. It will be running at your [localhost](http://localhost).\n\n\n### Surf to Firefly III {#surf-to-firefly-iii}\n\n\nYou can now visit Firefly III at [http://localhost](http://localhost) or [http://docker-ip:port](http://docker-ip:port) if it is running on a custom port. To continue, read [the tutorial on how to create accounts and transactions](/tutorials/finances/first-steps/).\n\n\n## Plain Docker {#plain-docker}\n\n\nYou can also use Docker itself, skipping Docker Compose. This allows you to set up a single container, with just Firefly III inside of it. If you do this, you should already have a MySQL or a Postgres database running somewhere. Without such a database container, Firefly III will not work.\n\n\n### Create a volume {#create-a-volume}\n\n\nThis volume is used to persistently store uploaded files.\n\n```text\ndocker volume create firefly_iii_upload\n```\n\n\n### Start the container {#start-the-container_1}\n\n\nRun this Docker command to start the Firefly III container. Edit the environment variables to match your own database. You should really change the `APP_KEY` as well. It should be a random string of _exactly_ 32 characters. You can generate such a key with the following command: \n\n```bash\nhead /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 32 && echo\n```\n\nAvoid special characters like `=`, `#` and others in the `APP_KEY` variable.\n\n```text\ndocker run -d \\\n-v firefly_iii_upload:/var/www/html/storage/upload \\\n-p 80:8080 \\\n-e APP_KEY=CHANGEME_32_CHARS \\\n-e DB_HOST=CHANGEME \\\n-e DB_PORT=3306 \\\n-e DB_CONNECTION=mysql \\\n-e DB_DATABASE=CHANGEME \\\n-e DB_USERNAME=CHANGEME \\\n-e DB_PASSWORD=CHANGEME \\\nfireflyiii/core:latest\n```\n\nFirefly III assumes that you're using MySQL. If you use PostgreSQL, change the following environment variable in the command: `DB_CONNECTION=pgsql` and change the port, `DB_PORT=5432`.\n\n\n\n> [!NOTE]\n> To connect to a database on your host machine from Firefly III running in Docker, set `DB_HOST=host.docker.internal`. For Linux users, you'll need to include the `--add-host=host.docker.internal:host-gateway` option.\n\n\n\nWhen executed this command will fire up a Docker container with Firefly III inside of it. It may take some time to start. If the database is set up properly it will automatically migrate and install a default database, and you should be able to surf to your container (usually located at [localhost](http://localhost)) to use Firefly III.\n\nIf you have questions, please refer to [the Docker FAQ](/references/faq/docker/) or contact me using the instructions from the [support page](/explanation/support/).\n",
      "documentId": "how-to/firefly-iii/installation/docker",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/docker/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/docker/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/installation/portainer/index.md",
      "kind": "page",
      "title": "Installation using Portainer",
      "description": "Portainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/portainer/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/portainer/index.md",
      "file": "how-to/firefly-iii/installation/portainer/index.md",
      "searchText": "\n# Installation using Portainer {#installation-using-portainer}\n\n\nPortainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes.\n\nYou can add Firefly III and the Data Importer as a \"stack\" using the instructions below.\n\n\n## Preparation {#preparation}\n\n\nYou will need to download and save the following configuration files:\n\n1. [Docker compose](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose-importer.yml) file\n2. This [stack.env](https://support.firefly-iii.org/composed.php) file with all the environment variables. Save it as `stack.env`.\n\n\n### Edit docker compose file {#edit-docker-compose-file}\n\n\nFirst, open the docker compose file in your favorite editor, and change all references under `env_file:` to say `env_file: stack.env`.\n\n\n\n> [!TIP]\n> All `env_file:` references must be pointing to exactly `stack.env`. Nothing else.\n\n\n\nSecond, update line 60, the that says `PLEASE_REPLACE_WITH_32_CHAR_CODE` and change it to a 32-character code. You need a random string at this point. If you don't want to make one up, [create one on this page](https://www.random.org/strings/?num=1&len=32&digits=on&upperalpha=on&loweralpha=on&unique=on&format=html&rnd=new). This 32-character code is used to secure the cron job.\n\n\n### Edit stack.env {#edit-stackenv}\n\n\nYou must do a few things:\n\n1. Change `DB_PASSWORD` in `stack.env` to something else. Pick a nice password.\n2. Also change `MYSQL_PASSWORD` in `stack.env` to the SAME value (it's at the bottom)\n3. Change `FIREFLY_III_URL` in `stack.env` to `http://app:8080`\n4. Change `VANITY_URL` in `stack.env` to `http://localhost`\n5. Change `STATIC_CRON_TOKEN` to the value you generated in the previous step.\n\n\n## Installation {#installation}\n\n\n\n### Add docker compose file {#add-docker-compose-file}\n\n\nOpen Portainer and go to the environment where you want to install Firefly III. This is usually the \"local\" one. Then, select \"Stacks\" in the left-hand menu. Click \"Add stack\".\n\nGive your stack the name `firefly-iii`, and copy-paste the content of your edited docker compose file.\n\n![Creating a stack](/_media/c6abd0e4b50412ee38a3.png)\n\n\n### Add stack.env file {#add-stackenv-file}\n\n\nUpload the `stack.env` file here. You will see that Portainer will expand all the environment variables in the file.\n\n![Loading environment variables](/_media/b8551edd4eeeb945b35c.png)\n\nIf you did not make the changes indicated earlier, now is the time.\n\n![Editing environment variables](/_media/4306e902b1af42b3c274.png)\n\n\n## Deploy! {#deploy}\n\n\nPress the button to get the stack deployed! After a while, it should run as expected.\n\n![Portainer stack](/_media/1b2a95660c2ed196c222.png)\n\n![Portainer final overview](/_media/cf4e79a8916d6359775b.png)\n\nThe default configuration will run Firefly III on port 80 which means you can visit Firefly III at [http://localhost](http://localhost). If your portainer is running somewhere else, or in a different configuration, the URL will be different of course.\n\nThe data importer (again, in the default configuration) can be reached at [http://localhost:81](http://localhost:81).\n\nFrom this point forward, you can follow these tutorials and guides to help you set up:\n\n- [Tutorial: Create accounts and transactions](/tutorials/finances/first-steps/)\n- [Tutorial: My first accounts](/tutorials/finances/first-accounts/)\n- [Tutorial: Import a basic CSV file](/tutorials/data-importer/csv/)\n\n",
      "documentId": "how-to/firefly-iii/installation/portainer",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/portainer/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/portainer/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/installation/kubernetes/index.md",
      "kind": "page",
      "title": "Kubernetes",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/kubernetes/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/kubernetes/index.md",
      "file": "how-to/firefly-iii/installation/kubernetes/index.md",
      "searchText": "\n# Kubernetes {#kubernetes}\n\n\nIn the [GitHub repository](https://github.com/firefly-iii/kubernetes) you will find a bunch of YAML files that denote a pretty standard service offering for both Firefly III and an accompanying MySQL database.\n\nYou can find more [instructions on GitHub](https://firefly-iii.github.io/kubernetes/). \n\n\n\n> [!NOTE]\n> These instructions aren't very long, and I'm sorry about that. Most stuff is documented on the GitHub page and I just don't know very much about Kubernetes myself. If you feel you can expand this page, please press the edit button next to the title\n\n\n",
      "documentId": "how-to/firefly-iii/installation/kubernetes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/kubernetes/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/kubernetes/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/installation/self-managed/index.md",
      "kind": "page",
      "title": "Self-managed server",
      "description": "If you have your own (virtual) web server you can use this guide to install Firefly III. You may have some ingredients prepared already.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/self-managed/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/self-managed/index.md",
      "file": "how-to/firefly-iii/installation/self-managed/index.md",
      "searchText": "\n# Self-managed server {#self-managed-server}\n\n\nIf you have your own (virtual) web server you can use this guide to install Firefly III. You may have some ingredients prepared already.\n\n\n\n> [!NOTE]\n> Some of these commands use the `sudo` or `sudo -u www-data` command. These are only available when you have the necessary privileges. If you do not have these privileges, you may need to ask your system administrator to run these commands for you.\n\n\n\n\n## Ingredients {#ingredients}\n\n\nYou need a working LAMP, LEMP or WAMP (1) stack. Make sure you use PHP %PHPVERSION. How to set this up is outside the scope of this manual, but this is something [you can look up](https://www.google.com/search?q=lamp+stack+php+%PHPVERSION).\n\n1. Linux, Apache, MySQL, PHP (LAMP) or Linux, Nginx, MySQL, PHP (LEMP) or Windows, Apache, MySQL, PHP (WAMP).\n\nYou will also need a (MySQL) database and credentials for a user that has permissions on that database. Firefly III creates its own tables. You can use SQLite if this is difficult to set up. \n\nIn case you want to use one of the languages that Firefly III is equipped with, make sure you install the necessary locales. For Debian / Ubuntu for example, use `sudo apt install language-pack-nl-base && sudo locale-gen`.\n\nSeveral users have created specific guides for their OS and database combination. \n\n1. [Firefly III in Ubuntu 20.04 and proxmox](https://gist.github.com/Engr-AllanG/34e77a08e1482284763fff429cdd92fa)\n2. [Firefly III Gulp orchestration scripts](https://github.com/sidyes/firefly-iii-gulp)\n3. [Firefly III on FreeBSD](https://www.davidschlachter.com/misc/firefly-iii-freebsd)\n\n\n## Preparing your server {#preparing-your-server}\n\n\n\n### Extra packages {#extra-packages}\n\n\nInstall the following PHP modules:\n\n* PHP BCMath Arbitrary Precision Mathematics\n* PHP Internationalization extension\n* PHP Curl\n* PHP Zip\n* PHP libsodium\n* PHP GD\n* PHP XML\n* PHP MBString\n* PHP support for whatever database you're going to use.\n\nYou can search the web to find out how to install these modules. Some may be installed already depending on your system. Use `phpinfo()` or `php -i` to find out.\n\n\n## Installing Firefly III {#installing-firefly-iii}\n\n\n\n\n> [!WARNING]\n> **Installing by pulling the remote repository**\n>\n> It's no longer possible to install Firefly III by pulling the code from the `main` or `develop` branch of the repository. Generated (JS) code and other dependencies are not in the repository, so your new installation may not work as expected. To do so manually, please [review this FAQ question](/references/faq/install/#i-want-to-build-the-firefly-iii-release-myself)\n\n\n\n\n### Main command {#main-command}\n\n\n%FFVERSION is the [latest version](https://version.firefly-iii.org/).\n\n- [Download the latest release as a `zip` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.zip) from GitHub.\n- [Download the latest release as a `tar.gz` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.tar.gz) from GitHub.\n\nIt is up to you, if you prefer the `tar.gz` file or the zip file.\n\n\n### Validate the downloaded file {#validate-the-downloaded-file}\n\n\nOptionally, you can validate and test the integrity of your download by also downloading the SHA256 checksum file. \n\n- [SHA256 checksum file of the `zip` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.zip.sha256).\n- [SHA256 checksum file of the `tar.gz` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.tar.gz.sha256).\n\nWith this SHA256 checksum file, you can verify the integrity of the download by running the following command:\n\n```bash\n# Should return: \"FireflyIII-%FFVERSION.zip: OK\"\nsha256sum -c FireflyIII-%FFVERSION.zip.sha256\nsha256sum -c FireflyIII-%FFVERSION.tar.gz.sha256\n\n# alternative command:\nshasum -a 256 -c FireflyIII-%FFVERSION.zip.sha256\nshasum -a 256 -c FireflyIII-%FFVERSION.tar.gz.sha256\n```\n\nIf you also want to verify the digital signature of the release, please follow the instructions under \"Verify the signature\" on [the page about signatures](/explanation/more-information/signatures/#verify-the-signature).\n\n\n### Extract the file {#extract-the-file}\n\n\nExtract the downloaded file in your web server's root directory, or in a specific directory you want to use.\n\n\n\n> [!TIP]\n> Some servers require `sudo` to extract or change things in the `/var/www` directory, because the directory is owned by a dedicated user (e.g. `www-data` on Debian/Ubuntu). If this is the case for you, make sure to prefix the commands in this document with `sudo -u www-data` (replace `www-data` with this username) to ensure that all of your files have the same permissions.\n\n\n\n```bash\n# the directory name is up to you, of course:\nmkdir /var/www/firefly-iii\nunzip FireflyIII-%FFVERSION.zip -d /var/www/firefly-iii\n\n# the tar.gz file extracts with the following command.\ntar -xvf FireflyIII-%FFVERSION.tar.gz -C /var/www/firefly-iii\n```\n\n\n\nThis should get you the entire installation in the directory of your choice.\n\n\n### Web server configuration {#web-server-configuration}\n\n\n\n\n> [!IMPORTANT]\n> Since this is very specific to each system, there are no instructions how to do this.\n\n\n\nMost servers will serve files from the `/var/www` directory. Firefly III would be served from `/firefly-iii/public`. This is not really what you would want to do.\n\nYou can look up for your webserver (Apache or nginx) how to change the root directory or how to set up virtual hosts. \n\n\n### Firefly III configuration {#firefly-iii-configuration}\n\n\nIn the directory where you just unzipped Firefly III you will find a `.env.example` file. Rename or copy it to `.env`. \n\n```bash\ncp .env.example .env\n```\n\nOpen this file using your favorite editor. There are instructions what to do in this file.\n\nMake sure you configure at least the database. For SQLite, you must drop all the configuration except `DB_CONNECTION=sqlite`.\n\n\n### Initialize the database {#initialize-the-database}\n\n\nThis step is very important, because Firefly III needs a database to work with, and it will tell you whether your configuration is correct.\n\n\n#### SQLite {#sqlite}\n\n\nIf you decide to use SQLite, make sure you run the following command to create the SQLite database file.\n\n```bash\n# the directory may be different on your system:\ncd /var/www/firefly-iii\ntouch ./storage/database/database.sqlite\n```\n\n\n#### MariaDB {#mariadb}\n\n\nInstall Mariadb, create a user and a database for Firefly III, and grant all privileges to that new user for this database\n\nExample-setup for a locally installed MariaDB database on the same server as the webserver where Firefly App resides.\n\n```bash\nCREATE USER firefly3@localhost IDENTIFIED BY 'firefly3';\ncreate database firefly3;\ngrant all privileges on firefly3.* to 'firefly3'@'localhost';\n```\n\n\n#### General {#general}\n\n\nEither way, in all cases, run these commands to initialize the database:\n\n```bash\nphp artisan firefly-iii:upgrade-database\nphp artisan firefly-iii:correct-database\nphp artisan firefly-iii:report-integrity\nphp artisan firefly-iii:laravel-passport-keys\n```\n\nNow you should be able to visit [http://localhost](http://localhost) and see Firefly III.\n\n\n### It doesn't work! {#it-doesnt-work}\n\n\nThis manual can't list all the possible exceptions and errors you may run into. Some common issues are documented [in the FAQ](/references/faq/install/).\n\nLook in these directions when you're running into problems:\n\n* Apache may not have mod_rewrite enabled or the htaccess file isn't activated (`AllowOverride`).\n* Nginx may not have the correct `try_files` instruction in the `location` block.\n\n\n## Visiting Firefly III {#visiting-firefly-iii}\n\n\nCheck out [the tutorial on creating accounts and transactions](/tutorials/finances/first-steps/).\n\n",
      "documentId": "how-to/firefly-iii/installation/self-managed",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/self-managed/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/self-managed/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/installation/hosted/index.md",
      "kind": "page",
      "title": "Third party hosting",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/hosted/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/hosted/index.md",
      "file": "how-to/firefly-iii/installation/hosted/index.md",
      "searchText": "\n# Third party hosting {#third-party-hosting}\n\n\nThere 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.\n\nYou can find the full list on [the page with third party hosting providers](/references/firefly-iii/third-parties/host/).\n",
      "documentId": "how-to/firefly-iii/installation/hosted",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/hosted/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/installation/hosted/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/upgrade/docker/index.md",
      "kind": "page",
      "title": "How to upgrade Firefly III",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/docker/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/docker/index.md",
      "file": "how-to/firefly-iii/upgrade/docker/index.md",
      "searchText": "\n# How to upgrade Firefly III {#how-to-upgrade-firefly-iii}\n\n\nFirefly 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.\n\n\n\n> [!WARNING]\n> Always make a backup of your database and volumes before you upgrade, especially when you upgrade major versions.\n\n\n\n\n## Docker Compose {#docker-compose}\n\n\nTo update the container run these commands:\n\n```bash\ndocker compose stop\ndocker compose pull\ndocker compose -f docker-compose.yml up -d --remove-orphans\n```\n\nIf you re-download `docker-compose.yml`, keep in mind that the database version in the Docker composer may have been updated and that this version is not compatible with your current version (ie MariaDB 10 vs MariaDB 11).\n\n\n## Straight from Docker Hub {#straight-from-docker-hub}\n\n\nTo upgrade, stop and remove your container using these commands:\n\n```bash\ndocker stop <container>\ndocker rm <container>\n```\n\nTo find out which container is Firefly III, run `docker container ls -a`.\n\n```bash\ndocker pull fireflyiii/core:latest\n```\n\nAnd then create it again by running the command from the installation guide. The container should upgrade itself, so it can take some time for it to start. You can save the command you've used to start the container for quicker upgrade.\n\n",
      "documentId": "how-to/firefly-iii/upgrade/docker",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/docker/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/docker/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/upgrade/kubernetes/index.md",
      "kind": "page",
      "title": "Kubernetes",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/kubernetes/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/kubernetes/index.md",
      "file": "how-to/firefly-iii/upgrade/kubernetes/index.md",
      "searchText": "\n# Kubernetes {#kubernetes}\n\n\nIn the [GitHub repository](https://github.com/firefly-iii/kubernetes) you will find a bunch of YAML files that denote a pretty standard service offering for both Firefly III and an accompanying MySQL database.\n\nYou can find more [instructions on GitHub](https://firefly-iii.github.io/kubernetes/).\n\n\n\n> [!NOTE]\n> These instructions aren't very long, and I'm sorry about that. Most stuff is documented on the GitHub page and I just don't know very much about Kubernetes myself. If you feel you can expand this page, please press the edit button next to the title\n\n\n",
      "documentId": "how-to/firefly-iii/upgrade/kubernetes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/kubernetes/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/kubernetes/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/upgrade/self-managed/index.md",
      "kind": "page",
      "title": "Upgrade a self-managed server",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/self-managed/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/self-managed/index.md",
      "file": "how-to/firefly-iii/upgrade/self-managed/index.md",
      "searchText": "\n# Upgrade a self-managed server {#upgrade-a-self-managed-server}\n\n\nFirefly 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.\n\n\n\n> [!WARNING]\n> Always make a backup of your database and `storage` before you upgrade, especially when you upgrade major versions.\n\n\n\n\n## Created using composer \"create-project\" {#created-using-composer-create-project}\n\n\nThe best way to upgrade is to use the \"Straight from GitHub\" instructions below. In recent times, the deployment of Firefly III has changed and the \"create-project\" method is no longer recommended. \n\n\n## Straight from GitHub {#straight-from-github}\n\n\n\n\n> [!WARNING]\n> **Upgrading by pulling the remote repository**\n>\n> It's no longer possible to upgrade Firefly III by pulling the code from the `main` or `develop` branch of the repository. Generated (JS) code and other dependencies are not in the repository, so your upgraded installation may not work as expected.\n\n\n\n%FFVERSION is the [latest version](https://version.firefly-iii.org/).\n\n- [Download the latest release as a `zip` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.zip) from GitHub.\n- [Download the latest release as a `tar.gz` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.tar.gz) from GitHub.\n\nIt is up to you, if you prefer the `tar.gz` file or the `zip` file.\n\n\n### Validate the downloaded archive {#validate-the-downloaded-archive}\n\n\nOptionally, you can validate and test the integrity of your download by also downloading the SHA256 checksum file.\n\n- [SHA256 checksum file of the `zip` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.zip.sha256).\n- [SHA256 checksum file of the `tar.gz` file](https://github.com/firefly-iii/firefly-iii/releases/download/%FFVERSION/FireflyIII-%FFVERSION.tar.gz.sha256).\n\nWith this SHA256 checksum file, you can verify the integrity of the download by running the following command:\n\n```bash\n# Should return: \"FireflyIII-%FFVERSION.zip: OK\"\nsha256sum -c FireflyIII-%FFVERSION.zip.sha256\nsha256sum -c FireflyIII-%FFVERSION.tar.gz.sha256\n\n# alternative command:\nshasum -a 256 -c FireflyIII-%FFVERSION.zip.sha256\nshasum -a 256 -c FireflyIII-%FFVERSION.tar.gz.sha256\n```\n\n\n### Move the old installation {#move-the-old-installation}\n\n\nMove the old installation to a temporary directory, ie `firefly-iii-old`. Example commands:\n\n```bash \n# moves the entire installation to a backup directory.\n# this also serves as an impromptu backup of your installation\nmv /var/www/firefly-iii /var/www/firefly-iii-old\n```\n\n\n### Extract the archive {#extract-the-archive}\n\n\nExtract the archive with the new release wherever you had installed Firefly III. In this example, it is `/var/www/firefly-iii`, but it could be anywhere. To do this over the command line, use the following command:\n\n```bash\n# The destination directory can be changed, of course.\nmkdir /var/www/firefly-iii\nunzip -o FireflyIII-%FFVERSION.zip -x \"storage/*\" -d /var/www/firefly-iii\n\n# a tar.gz alternative:\nmkdir /var/www/firefly-iii\ntar -xvf FireflyIII-%FFVERSION.tar.gz -C /var/www/firefly-iii --exclude='storage'\n```\n\n\n### Exclude the storage directory {#exclude-the-storage-directory}\n\n\nWhen unpacking, make sure you do not overwrite the storage directory. That's why the `-x \"storage/*\"` and `--exclude='storage'` part is important. It prevents the default storage directory from being extracted. You will overwrite it anyway from the old installation directory.\n\n\n### Copy over files from the old version {#copy-over-files-from-the-old-version}\n\n\nCopy the `.env` file and the entire `storage` folder from the old installation to the new one. Example commands:\n\n```bash\n# copy the .env file\ncp /var/www/firefly-iii-old/.env /var/www/firefly-iii/.env\n\n# copy the storage directory\ncp -r /var/www/firefly-iii-old/storage /var/www/firefly-iii\n```\n\n\n### Run upgrade commands {#run-upgrade-commands}\n\n\nRun the following commands to upgrade the database and the application:\n\n```bash\nphp artisan migrate --seed\nphp artisan cache:clear\nphp artisan view:clear\nphp artisan firefly-iii:upgrade-database\nphp artisan firefly-iii:laravel-passport-keys\n```\n\n\n### Restore file permissions {#restore-file-permissions}\n\n\nUse `sudo` if necessary, but if you do, make sure that you set the ownership of the `/var/www/firefly-iii` directory to `www-data` again:\n\n```bash\n# The destination directory can be changed, of course.\nsudo chown -R www-data:www-data /var/www/firefly-iii\nsudo chmod -R 775 /var/www/firefly-iii/storage\n```\n\n\n## Alternatives {#alternatives}\n\n\nGitHub user @igoptx has created [this script](https://gist.github.com/igoptx/423dbf83c9bbd8285f30059b735eb13a) that can do the upgrade automatically. Please use this at your own risk.\n",
      "documentId": "how-to/firefly-iii/upgrade/self-managed",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/self-managed/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/upgrade/self-managed/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/advanced/notifications/index.md",
      "kind": "page",
      "title": "How to set up notifications and emails",
      "description": "Firefly III can send notifications for specific events. Check out /settings/notifications and /preferences for a set of notifications you can receive.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/notifications/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/notifications/index.md",
      "file": "how-to/firefly-iii/advanced/notifications/index.md",
      "searchText": "\n# How to set up notifications and emails {#how-to-set-up-notifications-and-emails}\n\n\nFirefly III can send notifications for specific events. Check out `/settings/notifications` and `/preferences` for a set of notifications\nyou can receive.\n\n\n## Email {#email}\n\n\nThe Firefly III notification setting page (located at `/settings/notifications`) contain a test button that will send a test email message.\n\nThe configuration values for email are in the `.env`-file.\n\n```\nMAIL_MAILER=log\nMAIL_HOST=smtp.mailtrap.io\nMAIL_PORT=2525\nMAIL_FROM=changeme@example.com\nMAIL_USERNAME=null\nMAIL_PASSWORD=null\nMAIL_ENCRYPTION=null\nSITE_OWNER=you@example.com\n```\n\n*Always* change the `MAIL_FROM` and `SITE_OWNER` email addresses. If these are wrong, mail will never work.\n\nThe `MAIL_MAILER`-setting indicates the system that is used for mailing. Firefly III supports the following mail systems: smtp, sendmail, mailgun, mandrill, sparkpost and log. Here is an explanation about each MAIL_MAILER option:\n\n\n### `log` {#log}\n\n\nThe default value will store messages in your log files instead of sending them. `APP_LOG_LEVEL` must be set to `debug` for the messages to appear.\n\n\n### `smtp` {#smtp}\n\n\nSMTP is the de-facto standard for sending email. If you want to use GMail or Outlook as mail system, set the mailer to `smtp`. Change the host, port and credentials. `MAIL_ENCRYPTION` must be `null`, `ssl`, `starttls` or `tls`, depending on your provider.\n\n\n### `sendmail` {#sendmail}\n\n\nUses the built-in sendmail configuration. If you choose this, you can leave the other values alone.\n\n\n### `mailgun` {#mailgun}\n\n\n[Mailgun](https://www.mailgun.com/) is an API that can send emails. Their 30-day free trial service allows for 5,000 free messages.\n\nTo configure these, fill in the `MAILGUN_DOMAIN`, `MAILGUN_SECRET`, and `MAILGUN_ENDPOINT`  values in your `.env` file. The `MAILGUN_DOMAIN` is the domain you've verified with Mailgun, the `MAILGUN_SECRET` is your Mailgun API key, and the `MAILGUN_ENDPOINT` is the Mailgun API endpoint, `api.mailgun.net`, if you are sending email from Mailgun's U.S. infrastructure, or `api.eu.mailgun.net`, from their EU infrastructure. `MAIL_FROM` must be set to an email address that is from your Mailgun's verified domain.\n\n\n### `sparkpost` {#sparkpost}\n\n\n[Sparkpost](https://www.sparkpost.com/) is another paid service. Find the `SPARKPOST_SECRET` to configure sending email over Sparkpost. Note that I haven't actually tested this.\n\n\n### `mailersend` {#mailersend}\n\n\n[Mailersend](https://www.mailersend.com/) is another paid service, but it includes free tiers. Find the `MAILERSEND_API_KEY` to configure sending email over Mailersend.\n\n\n## Slack {#slack}\n\n\nFirefly III can also send notifications to a Slack channel. Administrators can set an \"Incoming Webhook URL\" under `/settings/notifications`. Users can set an \"Incoming Webhook URL\" under `/preferences`.\n\nTo create a Slack Webhook URL, you have to go \"Setting and Administration\" of the workspace in which you want to receive notifications. Click \"Configure Apps\", then \"Build\" in the top-right corner. Click \"Create New App\", and select \"From Scratch\". Give the app a nice name and select a workspace.\n\nFinally, click \"Incoming Webhooks\" and activate the feature. At the bottom of the page you can then create a new webhook. Select the channel in which you want the app (and by extension, Firefly III) to post. The URL you receive is the URL required for Firefly III. It starts with `https://hooks.slack.com/services`.\n\n\n\n> [!IMPORTANT]\n> If you are the only user of your Firefly III instance, you must set (the same) Webhook URL in both locations (\"Options\" > \"System settings\" > \"Settings for notifications\" AND \"Options\" > \"Preferences\").\n\n\n\n\n## Discord and Mattermost {#discord-and-mattermost}\n\n\nFirefly III can also send the notifications to a Discord or Mattermost channel. Channel admins can create a webhook in a Discord-channel, which you can use wherever you see a Slack URL. Similarly, Mattermost users can create a webhook in a Mattermost-channel.\n\nWhen you use the Discord/Mattermost webhook URL, you must add `/slack` to the end of the URL. So if your Discord webhook URL is `https://discord.com/api/webhooks/123456789/ABCdefgh`, you must use `https://discord.com/api/webhooks/123456789/ABCdefgh/slack` in Firefly III. The same applies to Mattermost URLs.\n\n\n\n> [!IMPORTANT]\n> If you are the only user of your Firefly III instance, you must set (the same) Webhook URL in both locations (\"Options\" > \"System settings\" > \"Settings for notifications\" AND \"Options\" > \"Preferences\").\n\n\n\n\n## Webhooks and ... webhooks? {#webhooks-and--webhooks}\n\n\nFirefly III also supports [webhooks](/how-to/firefly-iii/features/webhooks/) which will make Firefly III send out transaction events to the outside world. This is not the same as the Discord/Slack URL you've seen previously that also mention \"hooks\" and \"webhooks\". It's all called webhooks. \n\nTo make it a little easier to understand, here are some pointers:\n\n- When you are on the `/preferences`- or `/settings/notifications`-page you must use the Discord or Slack URL\n- When you are any `/webhooks/*`-page, DO NOT use the Discord or Slack URL\n",
      "documentId": "how-to/firefly-iii/advanced/notifications",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/notifications/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/notifications/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/advanced/authentication/index.md",
      "kind": "page",
      "title": "How to use different authentication",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/authentication/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/authentication/index.md",
      "file": "how-to/firefly-iii/advanced/authentication/index.md",
      "searchText": "\n# How to use different authentication {#how-to-use-different-authentication}\n\n\nBy default, Firefly III uses a basic system that allows users to register and login locally. This is based on the user's email address.\n\nSee also [how to make Firefly III multi-user](/how-to/firefly-iii/features/multi-user/).\n\n\n## Two-step authentication {#two-step-authentication}\n\n\nTwo-step authentication, or two-factor authentication (2FA) asks you for an extra code to enter. This adds security, so even when you lose your password your account is still protected.\n\nYou can enable it in your profile.\n\n![The button is shown in your list of accounts.](/_media/5579dd10702bd72e5c7f.png)\n\nIf you enable 2FA, you will also see eight backup codes that you should save just in case you lose access to your Authenticator app.\n\n![The button is shown in your list of accounts.](/_media/e8ef2d6bb252526d1422.png)\n\nTo confirm your 2FA settings, submit a code from your Authenticator app **twice**. You may have to wait 30 seconds. In your settings, you will see the upgraded status for 2FA:\n\n![Options for 2FA.](/_media/952b400ca8f0c23ff146.png)\n\nIf you lose access to your 2FA data, anybody with access to the database can turn it off and get you back in. [Please check out the FAQ](/references/faq/firefly-iii/general/).\n\n\n## Remote user authentication {#remote-user-authentication}\n\n\nFirefly III supports [RFC 3875](https://tools.ietf.org/html/rfc3875#section-4.1.11) which means your users can authenticate using the `REMOTE_USER` header. When you enable this method, an authentication proxy in front of Firefly III MUST be set up to care of the user's login and authentication. This lets you use advanced login methods like hardware tokens, single sign-on, fingerprint readers and more. Once the authentication proxy says you're logged in, it will forward you to Firefly III.\n\nA very popular tool that can do this [Authelia](https://www.authelia.com/docs/).\n\n\n\n> [!WARNING]\n> When Firefly III is set up for remote user authentication, it will do absolutely **NO** checks on the validity of the header or the contents. Firefly III will not ask for passwords, it won't check for MFA, nothing. All authentication is delegated to the authentication proxy and Firefly III just doesn't care anymore.\n\n\n\nBe sure to turn off MFA in Firefly III, because that will remain in place.\n\n\n### Enable the remote user option {#enable-the-remote-user-option}\n\n\nTo enable this function change the `AUTHENTICATION_GUARD` environment variable to `remote_user_guard`.\n\nSet the `AUTHENTICATION_GUARD_HEADER` to the HTTP header that will contain the user's identifier (usually the email address or a username). If the identifier is not the email address, please set `AUTHENTICATION_GUARD_EMAIL` to the HTTP header that will contain the user's email address\n\n\n### How it works {#how-it-works}\n\n\nOnce you're authenticated by the proxy Firefly III will receive the request with your user ID in the `REMOTE_USER` header. Firefly III will then log you in.\n\n\n### The guard header was unexpectedly empty {#the-guard-header-was-unexpectedly-empty}\n\n\nAs a troubleshooting step, try setting the `AUTHENTICATION_GUARD_HEADER` environment variable to `HTTP_REMOTE_USER`.  If this doesn't work, unset the `AUTHENTICATION_GUARD_HEADER` environment variable and make the change below.\n\nThe header must be forwarded to Firefly III. For example, add the following lines to `public/.htaccess`.\n\n```\n    RewriteCond %{HTTP:REMOTE_USER} .\n    RewriteRule .* - [E=REMOTE_USER:%{HTTP:REMOTE_USER}]\n```\n\nThis is less than optimal when you're using the Docker image but if the header is sent to your reverse proxy and not to Firefly III directly, it may be necessary to make such a change.\n\n\n### Another remote user header {#another-remote-user-header}\n\n\nIf you are able to customize your authentication system to send a header other than `REMOTE_USER` to Firefly III, then set the `AUTHENTICATION_GUARD_HEADER` environment variable to the PHP name of that header.  For example, if the custom header is `FFIII-User`, then set `AUTHENTICATION_GUARD_HEADER` to `HTTP_FFIII_USER`.  Another benefit of using a custom header is that you do not need to change the `public/.htaccess` file as mentioned above.\n\nFirefly III uses email addresses as user identifiers. When you're using an external authentication guard that does not do this, Firefly III is incapable of emailing you.\n\nIf the user's email address is also available through a different HTTP header, then set the `AUTHENTICATION_GUARD_EMAIL` environment variable to the PHP name of that header.  For example, if the custom header is `FFIII-Email`, then set `AUTHENTICATION_GUARD_EMAIL` to `HTTP_FFIII_EMAIL`\n",
      "documentId": "how-to/firefly-iii/advanced/authentication",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/authentication/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/authentication/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/advanced/backup/index.md",
      "kind": "page",
      "title": "How to make a backup",
      "description": "Firefly III does not come with a built-in backup routine. Using your native OS tools is way more useful and faster.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/index.md",
      "file": "how-to/firefly-iii/advanced/backup/index.md",
      "searchText": "\n# How to make a backup {#how-to-make-a-backup}\n\n\nFirefly III does not come with a built-in backup routine. Using your native OS tools is way more useful and faster. \n\n\n\n> [!WARNING]\n> **Do not use the export function as a backup mechanism**\n>\n> The export function of Firefly III is *not* a backup mechanism\n\n\n\nGitHub user [@ddyykk](https://github.com/ddyykk) has written excellent [this backup guide](https://github.com/orgs/firefly-iii/discussions/9960) with some scripts too. Check it out!\n\n\n## Self-managed installation backup {#self-managed-installation-backup}\n\n\nGrab the following and store it somewhere safe:\n\n- The `.env` file in the root of your installation or the _exact_ command you've used to launch Firefly III.\n- The entire database, or the database file (in `/storage/database`);\n- All uploads from `/storage/upload`;\n\nThe database can be exported using tools like phpMyAdmin or pgAdmin.\n\nAfter you made a backup this way, the *first* thing you must do is restore it, to make sure it actually worked.\n\n\n## Docker {#docker}\n\n\nIf you're running Firefly III in Docker, back up the following:\n\n- The Docker variables you've used to launch the container (s), and especially the `APP_KEY`-variable.\n- Any secrets you have used (database passwords).\n- The two volumes used by Firefly III: \"upload\" and \"db\"\n\nThat way you have everything you need in case of problems.\n\nAfter you made a backup this way, the *first* thing you must do is restore it, to make sure it actually worked.\n\n\n### Manual backup using Docker {#manual-backup-using-docker}\n\n\nTo back up the database volume, you could run something like this.\n\nBack up with the following command:\n\n```bash\ndocker run --rm -v \"firefly_iii_db:/tmp\" \\\n    -v \"$HOME/backups/firefly:/backup\" \\\n    ubuntu tar -czvf /backup/firefly_db.tar /tmp\n```\n\nAnd restore with:\n\n```bash\ndocker run --rm -v \"firefly_iii_db:/recover\" \\\n    -v \"$HOME/backups/firefly:/backup\" \\\n    ubuntu tar -xvf /backup/firefly_db.tar -C /recover --strip 1\n```\n\n\n\n> [!WARNING]\n> Check that the volume exists **before** trying to back it up. If a named volume doesn't exist Docker will create an empty one, and the command will backup that empty volume. This *wipes out the existing backup*.\n>\n> To get a better idea of how this works, see Docker's [official documentation](https://docs.docker.com/storage/volumes/#backup-restore-or-migrate-data-volumes).\n\n\n\nAfter you made a backup this way, the *first* thing you must do is restore it, to make sure it actually worked.\n\n\n\n### Automated backup using Docker {#automated-backup-using-docker}\n\n\nSee [GitHub issue #4270](https://github.com/firefly-iii/firefly-iii/issues/4270) for some hints.\n\n\n### Automated backup using a bash script and crontab {#automated-backup-using-a-bash-script-and-crontab}\n\n\nAn installation of Firefly III installed using `docker compose` can be backed up using this script provided by GitHub user [@dawid-czarnecki](https://github.com/dawid-czarnecki). The script will back up the database, capture the Docker volumes, `.env`-file, and relevant Docker files. It will also back up the configuration of the [Firefly III Data Importer](/how-to/data-importer/installation/docker/) if you installed it with the same `docker-compose`-file.\n\nDownload the [firefly-iii-backuper.sh](https://gist.github.com/dawid-czarnecki/8fa3420531f88b2b2631250854e23381)-script and put it in the same location where your `docker-compose.yml` and `.env` files are located.\n\nCreate a cron job that will run regularly, like so. This will create the necessary backups in the `.tar` file, named after the current date.\n\n```bash\n1 01 * * * bash /home/myname/backuper.sh backup /home/backup/$(date '+\\%F').tar\n```\n\nThe same script can also restore the Docker configuration and the database, getting you up and running again. You can run this on the command line:\n\n\n```bash\nbash /home/myname/backuper.sh restore /home/backup/firefly-2022-01-01.tar\n```\n\nAfter you made a backup this way, the *first* thing you must do is restore it, to make sure it actually worked.\n",
      "documentId": "how-to/firefly-iii/advanced/backup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/backup/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/advanced/locales/index.md",
      "kind": "page",
      "title": "How to set up your local language",
      "description": "The locale you want to use is identified by a little piece of text, like this: en, English, en_US.utf8.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/locales/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/locales/index.md",
      "file": "how-to/firefly-iii/advanced/locales/index.md",
      "searchText": "\n# How to set up your local language {#how-to-set-up-your-local-language}\n\n\nSetting up the right \"locale\" is about:\n\n- How an amount is formatted (`$ 12.34` versus `12,45$`)\n- How dates are formatted (`17 сентябрь` or `September 17`?)\n\nThe locale you want to use is identified by a little piece of text, like this: `en`, `English`, `en_US.utf8`.\n\n\n\n> [!NOTE]\n> If your browser is set to \"English (US)\", the date input fields will show \"mm/dd/yyyy\" (which is the American way of formatting dates). There is no setting in Firefly III that can change that.\n\n\n\nIn order to make the demo site work (it’s an Ubuntu server) I run these commands:\n\n```text\nsudo apt-get install -y language-pack-nl-base\nsudo locale-gen\n```\n\nOn a debian server, edit `/etc/locale.gen` and remove the `#` in front of every entry you're interested in.\n\n```\nsudo nano /etc/locale.gen\nsudo locale-gen\n```\n\nYou can see which locales your system has by running\n\n```text\nlocale -a\n```\n\nDepending on your language, a specific list of locales is tried by Firefly III. They can be found on [GitHub](https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang). Open the directory of your language, then open `config.php` and look for the line `locale`.\n\n\n## Locale settings in Docker {#locale-settings-in-docker}\n\n\nThe Docker container cannot be extended with locales. Please see [this issue on GitHub](https://github.com/firefly-iii/firefly-iii/issues/9070) for instructions.\n\n\n## Locale settings on Windows and Linux {#locale-settings-on-windows-and-linux}\n\n\nWindows usually recognizes locale strings like these: `English` or `english`. Linux mostly looks for strings like these: `en_US` or `nl_NL`. Sometimes you see stuff like this: `en_US.utf8` which means that it's not just English (US), but also UTF8 (a special encoding).\n\nSo changing your locale in Firefly III on Windows may not work as you had expected. This is on my list for future improvements.\n\nKeep in mind some Linux installations only have `nl_NL.iso-8859-1` while Firefly III will always look for `nl_NL.utf8`.\n\nIf the user your system is running under is jailed, it may not have access to the necessary locales.\n\n\n### Missing translations or format instructions {#missing-translations-or-format-instructions}\n\n\nYou'll notice the formatting of the date is American, ie `septembre 17, 2020` even though you've set your locale and language to something else.\n\nThis is caused by missing translations. Let me know where you run into this issue.\n\n\n### Browsers {#browsers}\n\n\nWhen set to English (US) browsers will always format the date input fields as `09/17/2020`. Use a localized browser to fix this. Changing your Firefly III settings will not change the date input fields.\n\n![Date format in US browser](/_media/2686a8c418b249a43979.png)\n\n\n### Missing packages or configuration {#missing-packages-or-configuration}\n\n\nIf your server is missing the required packages, Firefly III won't be able to show the locale. You will see missing dots in numbers and other weird stuff.\n\n\n### Select the correct locale {#select-the-correct-locale}\n\n\nSelect \"Hungarian (Hungarian)\" and not \"Hungarian\". The list of locales is pretty specific so \"hu\" may not work on your system but \"hu_HU\" does.\n",
      "documentId": "how-to/firefly-iii/advanced/locales",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/locales/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/locales/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/advanced/cron/index.md",
      "kind": "page",
      "title": "Cron jobs",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/cron/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/cron/index.md",
      "file": "how-to/firefly-iii/advanced/cron/index.md",
      "searchText": "\n# Cron jobs {#cron-jobs}\n\n\nFirefly 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.\n\nYou should read up on [budgets](/how-to/firefly-iii/finances/budgets/) if you want to use cron jobs for auto-budgets. There are some interesting details to know about.\n\n\n## Cron authentication {#cron-authentication}\n\n\nTo run the cron job, you must do so on the command line, or over the web. If you try to access the cron job over the web, you have to provide an access token. This token can be found on your `/profile` page under the \"Command line token\" header. This will prevent others from spamming your cron job URL. An alternative to this token value is the `STATIC_CRON_TOKEN` environment variable. You can set this using the `.env` file, or by setting it through Docker. A little ahead on this page the difference is explained.\n\nIf you have multiple users that use your Firefly III installation, it is only necessary for one user to set up the cron job. The cron job will run for all users. It is OK if multiple users set up multiple runs of the cron job.\n\n\n\n## Calling a command {#calling-a-command}\n\n\nIf you are a bit of a Linux geek you can set up a cron job easily by running `crontab -e` on the command line. Some users may have to run `sudo crontab -u www-data -e` so the correct user will be referred to.\n\n```   \n# cron job for Firefly III\n0 3 * * * /usr/bin/php /var/www/html/artisan firefly-iii:cron\n```\n\nThe exact path to PHP and the path to Firefly III may be different in your case.\n\n\n### Extra information {#extra-information}\n\n\nIn order to trigger \"future\" cron jobs, you can call the cron job with `--force --date=YYYY-MM-DD`. This will make Firefly III pretend it's another day. This is useful for recurring transactions. Here is an example of a cron job that is triggered every first day of the month at 3am and pretends it's the tenth day of that month.\n\n```\n# cronjob for Firefly III that changes the target date.\n0 3 1 * * /usr/bin/php /var/www/html/artisan firefly-iii:cron --force --date=$(date \"+\\%Y-\\%m-\")10\n```\n\n\n\n### Systemd timer {#systemd-timer}\n\n\nYou can use `systemd` to run the jobs on a recurring schedule similar to cron. You will need to create two files: a unit file and a timer file.\n\nBegin by creating a new file instructing systemd what to run, `firefly-iii-cron.service`.\n\n```ini\n[Unit]\nDescription=Firefly III cron\nRequires=httpd.service php-fpm.service postgresql.service\n\n[Service]\nType=oneshot\nExecStart=/usr/bin/php /var/www/html/artisan firefly-iii:cron\n```\n\nYou will want to change the `Requires=` line to match the services that you are actually running. In this example we are using httpd (Apache), PHP FastCGI Process Manager (FPM), and PostgreSQL. Similarly, change the path to *your* path to the PHP binary and the path to *your* Firefly III installation.\n\nNext create a new file for the timer specification, `firefly-iii-cron.timer`.\n\n```ini\n[Unit]\nDescription=Firefly III cron\n\n[Timer]\nOnCalendar=daily\n\n[Install]\nWantedBy=timers.target\n```\n\nCopy these files to `/etc/systemd/system`. You must then enable (`systemctl enable firefly-iii-cron.timer`) and start (`systemctl start firefly-iii-cron.timer`) the timer. Verify the timer is registered with `systemctl --list-timers`. You may also want to run the service once manually to ensure it runs successfully: `systemctl start firefly-iii-cron.service`. You can check the results with `journalctl -u firefly-iii-cron`.\n\n\n## Request a page over the web {#request-a-page-over-the-web}\n\n\nYou can also use a tool called cURL.\n\n```\n# cron job for Firefly III using cURL\n0 3 * * * curl https://demo.firefly-iii.org/api/v1/cron/[token]\n```\n\nThe `[token]` value can be found on your `/profile` under the \"Command line token\" header. This will prevent others from spamming your cron job URL. An alternative to this token value is the `STATIC_CRON_TOKEN` environment variable. You can set this using the `.env` file, or by setting it through Docker. A little ahead on this page the difference is explained.\n\nIf you have multiple users that use your Firefly III installation, it is only necessary for one user to set up the cron job. The cron job will run for all users. It is OK if multiple users set up multiple runs of the cron job. \n\nBut, it is not necessary to configure a run of the cron job for all users. So, it does not matter which access token you use: that of any user, or the `STATIC_CRON_TOKEN`.\n\n\n\n## Cron jobs in Docker {#cron-jobs-in-docker}\n\n\nThe Docker image does *not* support cron jobs, but the Docker Compose file includes a cron job container. You can see it in [the online docker compose file](https://github.com/firefly-iii/docker/blob/main/docker-compose.yml).\n\n\n### Static cron token {#static-cron-token}\n\n\nThe web address for the cron job is protected by a token. You can find this token on the `/profile` page under \"Command line token\". This token is dynamic, and is generated separately for each user.\n\nWhen you use Docker, this can be difficult to configure. So, you can set the `STATIC_CRON_TOKEN` to a string of **exactly** 32 characters. This will also be accepted as cron token.\n\nFor example, use `-e STATIC_CRON_TOKEN=klI0JEC7TkDisfFuyjbRsIqATxmH5qRW` or change your `.env` file to include a generated token.\n\nSo there are two kinds of tokens you can use:\n\n1. The personal token from your `/profile` page\n2. A self-generated 32-character token, that you have added to `.env`\n\nEither way, the following instructions apply to Docker.\n\n\n### Docker compose {#docker-compose}\n\n\nThis is already present in the [default Docker compose file](https://github.com/firefly-iii/docker/blob/main/docker-compose.yml).\n\n```\n  cron:\n    #\n    # To make this work, set STATIC_CRON_TOKEN in your .env file or as an environment variable\n    # The STATIC_CRON_TOKEN must be *exactly* 32 characters long\n    #\n    image: alpine\n    restart: always\n    container_name: firefly_iii_cron\n    env_file: .env\n    command: sh -c \"\n      apk add tzdata && \\\n      ln -fs /usr/share/zoneinfo/$$TZ /etc/localtime && \\\n      echo \\\"0 3 * * * wget -qO- http://app:8080/api/v1/cron/$$STATIC_CRON_TOKEN;echo\\\"\n      | crontab - && \\\n      crond -f -L /dev/stdout\"\n    networks:\n      - firefly_iii\n    depends_on:\n      - app\n```\n\nThe `$$STATIC_CRON_TOKEN` variable (and yes, the double `$$` is **correct**) refers to the `STATIC_CRON_TOKEN=` line in your `.env` file.\n\nIf you have used the expanded Docker compose file or if you have added the cron container yourself, (re)start your stack. The cron job will run automatically. You can see the cron container if you do something like `docker container ls`:\n\n![Show relevant containers](/_media/ad14629cc652d2adecc8.png)\n\nYou can see the logs of the cron container by running `docker logs [container-id]`. Take the exact ID from the previous command.\n\nIn the logs you can see the cron job once it has run. This is what it looks like:\n\n```\nfetch https://dl-cdn.alpinelinux.org/alpine/v3.21/main/x86_64/APKINDEX.tar.gz\nfetch https://dl-cdn.alpinelinux.org/alpine/v3.21/community/x86_64/APKINDEX.tar.gz\n(1/1) Installing tzdata (2025b-r0)\nOK: 7 MiB in 16 packages\ncrond: crond (busybox 1.37.0) started, log level 8\ncrond: USER root pid  11 cmd wget -qO- http://app:8080/api/v1/cron/REPLACEME;echo\n{\"recurring_transactions\":{\"job_fired\":true,\"job_succeeded\":true,\"job_errored\":false,\"message\":\"Recurring transactions cron job fired successfully.\"},\"auto_budgets\":{\"job_fired\":true,\"job_succeeded\":true,\"job_errored\":false,\"message\":\"Auto-budget cron job fired successfully.\"},\"exchange_rates\":{\"job_fired\":true,\"job_succeeded\":true,\"job_errored\":false,\"message\":\"Exchange rates cron job fired successfully.\"},\"bill_notifications\":{\"job_fired\":true,\"job_succeeded\":true,\"job_errored\":false,\"message\":\"Bill notification cron job fired successfully.\"}}\n```\n\n\n### From outside the container (http) {#from-outside-the-container-http}\n\n\nIf you do not use the cron container, you can call your local container over the (local) network to execute the cron job. Check out the preceding documentation, it's no different.\n\n```\n# cron job for Firefly III using cURL\n0 3 * * * curl http://127.0.0.1:8080/api/v1/cron/REPLACEME\n```\n\n\n### From outside the container (cli) {#from-outside-the-container-cli}\n\n\nYou can also talk to the container directly. The command would be something like this:\n\n```\n# cron job for Firefly III using Docker itself\n0 3 * * * docker exec $(docker container ls -a -f name=firefly --format=\"{{.ID}}\") /usr/local/bin/php /var/www/html/artisan firefly-iii:cron\n```\n\n\n### Run an image that calls the cron job {#run-an-image-that-calls-the-cron-job}\n\n\nThis is a very fancy solution. It's basically the same solution as the previously mentioned docker compose file expansion, but this time we do it manually. Run the following command:\n\n```\ndocker create --name=FireflyIII-Cronjob alpine \\\n    sh -c \"echo \\\"0 3 * * * wget -qO- https://demo.firefly-iii.org/api/v1/cron/[TOKEN]\\\" | crontab - && crond -f -L /dev/stdout\"\n```\n\nThe `[token]` value can be found on your `/profile` under the \"Command line token\" header. Earlier on this page, you can read on the static token as well.\n\nIf you do not know the Firefly III URL, you can also use the Docker IP address.\n\n\n## IFTTT {#ifttt}\n\n\nYou can always use [If This, Then That (IFTTT)](https://ifttt.com). This will only work if your Firefly III installation can be reached from the internet. Here's what you do.\n\nLogin to IFTTT (or register a new account) and create a new applet:\n\n![Make a new applet](/_media/9767e1fa60ccd89d4d92.png)\n\nYou will get this screen. Select \"This\":\n\n![Select \"This\"](/_media/6b42ba2958e8653de782.png)\n\nSelect \"Date and Time\":\n\n![Select \"Date and time\"](/_media/0294890dc545df6dde54.png)\n\nSelect \"Every day at\":\n\n![Select \"Every day at\"](/_media/97d34e8701ffd7eeb00e.png)\n\nSet the time to 3AM:\n\n![Time to 3AM](/_media/34c27815e0be23022463.png)\n\nClick on \"That\":\n\n![Click on \"That\"](/_media/08fe9ebc9ac401141cb7.png)\n\nUse the search bar to search for \"Webhooks\".\n\n![Search for \"Webhooks\"](/_media/57604f27a834349898a4.png)\n\nClick on \"make a web request\"\n\n![Click on \"make a web request\"](/_media/69699c5bf9e091df8825.png)\n\nEnter the URL in the following format. Keep in mind that the image shows the WRONG URL. Sorry about that.\n\n`https://your-firefly-installation.com/api/v1/cron/[token]`\n\nThe `[token]` value can be found on your `/profile` under the \"Command line token\" header. This will prevent others from spamming your cron job URL. An alternative to this token value is the `STATIC_CRON_TOKEN` environment variable. You can set this using the `.env` file, or by setting it through Docker. A little earlier on this page the difference is explained.\n\n![The result of setting up IFTTT](/_media/b7b01b778a2d443dca3e.png)\n\nPress Finish to finish up. You can change the title of the IFTTT applet into something more descriptive, if you want to.\n\n![Finished up](/_media/b00e5440811b5e65b146.png)\n\nYou will see a final overview\n\n![Overview](/_media/75902ed8649adc725292.png)\n\nPress Finish, and you're done!\n\n\n## Force the cron job to run {#force-the-cron-job-to-run}\n\n\nDepending on your setup (see earlier on this page), you can force the cron job to run using:\n\n```\nphp artisan firefly-iii:cron --force\n```\n",
      "documentId": "how-to/firefly-iii/advanced/cron",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/cron/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/advanced/cron/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/accounts/index.md",
      "kind": "page",
      "title": "How to manage accounts",
      "description": "Although there's plenty of variation that you can apply here, this is how I recommend you manage accounts.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/accounts/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/accounts/index.md",
      "file": "how-to/firefly-iii/finances/accounts/index.md",
      "searchText": "\n# How to manage accounts {#how-to-manage-accounts}\n\n\nAlthough there's plenty of variation that you can apply here, this is how I recommend you manage accounts.\n\nSee also:\n\n- [Tutorial: create accounts and transactions](/tutorials/finances/first-steps/)\n- [Tutorial: my first accounts](/tutorials/finances/first-accounts/)\n- [Reference: all account types](/references/firefly-iii/account-types/)\n\n\n## Asset accounts {#asset-accounts}\n\n\nCreate one asset account for each bank account you have. Also create asset accounts for your savings accounts and credit cards.\n\nOther financial apps advise you to save your credit card as a liability, but in Firefly III I recommend you create it as an asset account.\n\n\n## Liabilities {#liabilities}\n\n\nCreate a liability for each outstanding or incoming loan. For example, your mortgage or student debt. Set the amount as a positive number. \n\n\n## Other account types {#other-account-types}\n\n\nYou don't need to create expense accounts and revenue accounts, they are automatically created when you create a transaction. \n\n\n## IBANs and account numbers {#ibans-and-account-numbers}\n\n\nIf you can, add IBANs and account numbers to the accounts when you know them. This will help you when importing data.\n\n\n## Deleting accounts {#deleting-accounts}\n\n\nIf you delete an account, any associated transactions will be removed as well. If you're deleting an asset account, and you've transferred money between the current asset account and other asset accounts, you might see changed balances all around. Remember to correct this, if necessary. You can move the transactions to a new account if you wish to preserve them.\n",
      "documentId": "how-to/firefly-iii/finances/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/accounts/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/accounts/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/budgets/index.md",
      "kind": "page",
      "title": "How to manage budgets",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/budgets/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/budgets/index.md",
      "file": "how-to/firefly-iii/finances/budgets/index.md",
      "searchText": "\n# How to manage budgets {#how-to-manage-budgets}\n\n\nFirefly 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.\n\nTo learn more about how budgets work in Firefly III, you should read about [budgets in Firefly III](/explanation/financial-concepts/budgets/).\n\nFirefly III budgeting works best when you work from the first day of the month to the last. This is even true when you get paid weekly or 13 times a year (4-weekly). It's also true when you get paid some random moment in a month. For more information on this, read [the explanation on managing your personal finances](/explanation/firefly-iii/background/personal-finances/).\n\n![Create a budget](/_media/69e20cd6f46ddef1f9f7.png)\n\n\n## Changing the date range {#changing-the-date-range}\n\n\nThe date range for budgets is tied to your view range, and you can change that in Preferences > Layout.\n\n\n## Basic budgets {#basic-budgets}\n\n\nOnce you have a few budgets, you can link them to your expenses when you create a transaction. See also, [how to organize transactions](/how-to/firefly-iii/finances/transactions/).\n\nThis is not very useful yet. So, on the `/budgets` page you  can set the maximum amount for the budget. This amount applies to the current period and for most users  this applies to the current month. Monthly budgeting is a common way of organizing your finances.\n\n![Overview](/_media/07552e53f341b5a7b103.png)\n\n\n## Automated budgets {#automated-budgets}\n\n\n\n\n> [!NOTE]\n> I'm talking about months here, but this works equally well for weeks or quarters.\n\n\n\nWhen the next month arrives, your budget amounts are gone, since they only applied to the previous month. You can set them again based on your experience from the previous month.\n\nYou can also make Firefly III do this for you. However, it requires that you know [how to run the cron job](/how-to/firefly-iii/advanced/cron/).\n\nAuto-budgets are only created on the first day of the period they're set to. If the cron job does not run on that particular moment, the amount will not be set automatically. Hence, the cronjob should run daily.\n\n| Auto-budget period | Moment amount is set     |\n|--------------------|--------------------------|\n| Daily              | Every day                | \n| Weekly             | Every Monday             | \n| Monthly            | First day of the month   |\n| Quarterly          | First day of the quarter |\n| Every half year    | June 1st, December 1st   |\n| Yearly             | First day of the year    |\n\nYou can't edit or change these moments. They are hard-coded into Firefly III.\n\n![Basic auto budget](/_media/3b0f942aab9d40bc69ec.png)\n\n\n## Budgets that grow {#budgets-that-grow}\n\n\nYou can also add money to the budget every month. That way, it grows every period. You start at 25, and if you spend nothing it grows to 50, 75, etc. every month.\n\n![Growing auto budget](/_media/143c6b90cc65b9128478.png)\n\n\n## Budgets that grow, but correct for expenses {#budgets-that-grow-but-correct-for-expenses}\n\n\nThe previous trick works if you want unspent money to be available in the next month. But what happens when you spend way too much? Imagine a monthly 25,- budget. But you decide to spend 35,-. Now what? Using this little trick, Firefly III will set your next month's budget to 15,-, correcting for the 10,- overspend.\n\nIf you spend more than twice your allotted amount, Firefly III will set the next month's budget to a symbolic 1,-. It's up to you to decide how to deal with it.\n\n![Also growing auto budget](/_media/dd218b3c6da75f2ce395.png)\n\n\n## Mixing periods {#mixing-periods}\n\n\nFirefly III doesn't really handle mixed periods well. Setting both a yearly AND a monthly budget is tricky. You can do this by changing the view range on your `/preferences` page and then visit the `/budgets` page again. If these periods for a budget overlap too, your expense will be deducted from both amounts. Also, Firefly III will not automatically calculate what a yearly budget would be per month.\n",
      "documentId": "how-to/firefly-iii/finances/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/budgets/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/budgets/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/transactions/index.md",
      "kind": "page",
      "title": "How to organize transactions",
      "description": "Transactions are, naturally, the core of how you manage your finances. You can create transactions manually or have them imported by the data importer.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/index.md",
      "file": "how-to/firefly-iii/finances/transactions/index.md",
      "searchText": "\n# How to organize transactions {#how-to-organize-transactions}\n\n\nTransactions are, naturally, the core of how you manage your finances. You can create transactions manually or have them imported by the data importer.\n\nTransactions have a few useful fields:\n\n* A description\n* The amount (duh)\n* The date\n* The accounts involved (from and to)\n* .. and some meta-information.\n\nIn Firefly III, a transaction can be a withdrawal, a deposit or a transfer. Beyond the obvious, they are slightly different from one another. The [reference to all transaction types](/references/firefly-iii/transaction-types/) explains more about them.\n\n\n## Withdrawals {#withdrawals}\n\n\nWithdrawals are meant to record expenses. The source account of each withdrawal is an asset account, and the destination account is an expense account.\n\nTo create a withdrawal select a source account first. This should be an [asset account](/how-to/firefly-iii/finances/accounts/) or a [liability](/how-to/firefly-iii/finances/liabilities/). Then select a destination account (an expense account) or free-type a new one. Withdrawals can also be assigned a [budget](/how-to/firefly-iii/finances/budgets/).\n\nAlthough the form allows you to free-type a destination account as well, this may fail and the transaction can't be saved.\n\nIf you want to store cash withdrawals, be sure to read [how to manage cash](/how-to/firefly-iii/finances/cash/).\n\n\n## Deposits {#deposits}\n\n\nWhen you wish to create a deposit, select a revenue account first, as the source account. When it doesn't exist yet, free-type your own input, and it will be created for you. Then, select an [asset account](/how-to/firefly-iii/finances/accounts/) or a [liability](/how-to/firefly-iii/finances/liabilities/) as the destination account. If the source account already exists the form will recognize that you're creating a deposit, and the \"budget\"-selector will disappear.\n\nAlthough the form allows you to free-type a destination account as well, this may fail and the transaction can't be saved.\n\nIf you want to store cash deposits, be sure to read [how to manage cash](/how-to/firefly-iii/finances/cash/).\n\n\n## Transfers {#transfers}\n\n\nA transfer is created only between existing asset accounts. Select an asset account for both the source and destination from the free-form fields. Transfers can be linked to [piggy banks](/how-to/firefly-iii/finances/piggy-banks/), to automatically add or remove money from the piggy bank you select.\n\n\n## Split transactions {#split-transactions}\n\n\nWhat has been described here are \"singular transactions\". Firefly III stores each financial transaction in a journal. Each journal contains two \"transactions\". One takes money (-250 from your bank account) and the other one puts it into another account (+250 for Amazon.com).\n\nYou can verify this by counting. There are always twice as many \"transactions\" as there are \"journals\" in your database.\n\nThis way, Firefly III tries to stay true to what a financial transaction is, which is kind of singular. Money moves from A to B, end of story. Nothing more.\n\nHowever, often an expense tells a story. Take grocery receipts for example. It's one expense sure, but it consists of many parts. And when you buy aspirin and bread at the same time, you might want to split the expense over two budgets, medication and groceries. A single expense would make you lose information.\n\nLikewise, your salary may have multiple components. Your base salary may be 1200. Plus 100 bonus. Etc. All that information is lost when you enter it using a singular, not split deposit.\n\n![Transaction with multiple parts](/_media/757653b2fe96f7d7c321.png)\n\nAny time you create a deposit, transfer or a withdrawal, Firefly III lets you **split** a transaction into multiple parts. When you do this, you can:\n\n* Assign part of an expense to a budget;\n* Assign different revenue accounts to parts of a deposit.\n* Categorize money differently.\n\nYou can split your entire groceries-receipt into small \"sub\"-transactions. Or you can specify each component of your salary.\n\n\n### Constraints {#constraints}\n\n\nIt's important to realise the following constraints when dealing with split transactions.\n\n* When making an expense (withdrawal), you can only split the destination accounts, not the source accounts. You can't create one expense that originates from two or three asset accounts. But you can divide a withdrawal over several expense accounts. You can split your groceries over several departments, but you can't pay a subscription from two asset accounts.\n* Deposits must end up in one asset account. You can't make a deposit from one revenue accounts and split it over separate asset accounts. Your salary, when divided over different splits, must end up in one asset account.\n* Transfers can be split, but all splits must have the same source + destination.\n\n\n## Transaction links {#transaction-links}\n\n\nMore often than not a transaction isn't just \"a transaction\" but a connected to some other transactions. Maybe you've been reimbursed money by your boss. Maybe an expense is paid back to you by a friend. Or perhaps a friend paid you back for something or other.\n\n![Inward link](/_media/259a42c1992313744854.png)\n\nIn Firefly III you can store these links between transactions. By default, four link types are available. You can see these under Administration > Transaction links configuration.\n\n* Is paid for by\n* Is refunded by\n* Is reimbursed by\n* Relates to\n\nThese links work both ways. When transaction A has been refunded by transaction B, B is noted to refund A.\n\n![Outward link](/_media/9efd553032ba65b1ca2f.png)\n\nYou can also add your own link types if you want to.\n\nTo make a link with another transaction, go to the overview of a transaction and use the \"Link transaction\" button under the transaction. If the transaction has been split, select the correct split to link. Select the correct type of link from the dropdown and select the transaction to be linked. Optionally you can add some comments.\n\nYou can remove or reverse a link once it has been created.\n\n\n### Use of links {#use-of-links}\n\n\nIt is important to realise that links don't *do* anything. They won't change your transactions, or subtract amounts or anything like that.\n\n",
      "documentId": "how-to/firefly-iii/finances/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/transactions/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/cash/index.md",
      "kind": "page",
      "title": "How to track cash",
      "description": "There are a few ways to manage your cash transactions in Firefly III. On this page you can read about them.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/cash/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/cash/index.md",
      "file": "how-to/firefly-iii/finances/cash/index.md",
      "searchText": "\n# How to track cash {#how-to-track-cash}\n\n\nThere are a few ways to manage your cash transactions in Firefly III. On this page you can read about them.\n\n\n## Using the built-in \"(cash)\" account {#using-the-built-in-cash-account}\n\n\nThe best way to manage cash in Firefly III, and the best way to manage your sanity, is _not_ to track your cash money. Instead, whenever you withdraw money from an ATM you consider the entire amount as lost, and you move on. This is useful when you use cash on but a few occasions like when you go out for drinks or when you pay the handy man, so he can avoid taxes.\n\nTo do this in Firefly III, whenever you withdraw cash you leave the \"destination account\" field empty, like so:\n\n![Making a new transaction for the (cash) account.](/_media/b59c83b4ff96cf0acd0c.png)\n\nWhen you do this the transaction will mention _(cash)_ and the money is one big withdrawal:\n\n![View a transaction for the (cash) account.](/_media/f251e7997faee918d4b2.png)\n\nThis works the other way around as well, if you want to deposit cash into your checking account you just leave the Source Account field empty.\n\n\n## With separate cash account {#with-separate-cash-account}\n\n\nIf you use cash a lot and when you want to keep track of it, you can create a cash wallet account or use the one built into Firefly III. That way, you can track all the cash you take from an ATM for example.\n\nYou put cash money into your wallet by transferring it from your checking account to your cash wallet, like so:\n\n![Making a new transaction for a cash wallet.](/_media/36cd1a582b0b8c11b4f1.png)\n\nThe result looks like this:\n\n![View a transaction for the cash wallet.](/_media/c0031e6973eb6cfa697e.png)\n\nYou can then spend your cash money as you please.\n\n\n### Tracking lost money {#tracking-lost-money}\n\n\nIf you use the \"(cash)\" account there's no need to do this.\n\nBut if you use the \"cash wallet\", you will run into a problem when you lose money, get short-changed or get robbed or something. Personally, I recommend spending money at \"the abyss\" or make an expense account with a similar amount like \"money lost\":\n\n![Create a transaction about money lost.](/_media/93701364b962ac1262b0.png)\n\nAnd the result is that you can see where you lost your money:\n\n![View a transaction about money lost.](/_media/548e9472d079bfa85350.png)\n\n\n## Cash and multi-currency {#cash-and-multi-currency}\n\n\nIf you go to an ATM and withdraw an amount in dollars when you always work with Euro's, you'll have to store the transaction in such a way that your balance still works out. If you use \"(cash)\":\n\n![Create a multi-currency cash withdrawal.](/_media/d14b4327733c4dcf484b.png)\n\n![View a multi-currency cash withdrawal.](/_media/a5bc0e1b1aff4db6cba3.png)\n\nIf you use a separate cash account, ensure the foreign currency is recorded correctly, _and_ make a separate cash account to track these transactions.\n\n![Create a multi-currency cash transfer to your wallet.](/_media/29d5e4a2143acfb2f0d4.png)\n\n![View a multi-currency cash transfer to your wallet.](/_media/2532fa6383e6090c78d9.png)\n",
      "documentId": "how-to/firefly-iii/finances/cash",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/cash/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/cash/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/subscriptions/index.md",
      "kind": "page",
      "title": "How to use subscriptions?",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/subscriptions/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/subscriptions/index.md",
      "file": "how-to/firefly-iii/finances/subscriptions/index.md",
      "searchText": "\n# How to use subscriptions? {#how-to-use-subscriptions}\n\n\nIn 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](/explanation/financial-concepts/subscriptions/).\n\n\nYou can create subscriptions for your common recurring expenses. You can use [rules](/how-to/firefly-iii/features/rules/) to automatically link transactions to subscriptions.\n\nWhen you create a new subscription, Firefly III asks you for the minimum and maximum amount that you expect the subscription to be. This is important, because the average of these two amounts is used in charts and overviews.\n\n\n## An overview of your subscriptions {#an-overview-of-your-subscriptions}\n\n\n![Overview of subscriptions](/_media/4f2bc86fd76dbc9a361f.png)\n\nOn this screenshot you see the subscription overview from the demo site. You see that subscriptions can have a variety of periods, and that they can be active and inactive.\n\nYou'll also see that Firefly III tells you when to expect the subscription. \n\n![The subscriptions on the dashboard](/_media/cef97cf0368ab0ded57c.png)\n\nThe front page of Firefly III will also start showing the subscriptions. This box takes the average expected amount of the subscription (see ahead) and the amount already paid.\n\n\n## Create a new subscription {#create-a-new-subscription}\n\n\n![Create a new subscription](/_media/4c53ed47194dae2c081e.png)\n\nWhen you create a subscription, you tell Firefly III the description and how often it repeats, etc., but also in what range you expect the subscription to be.\n\nYou can also set the end date and the extension date. If you know [how to set up a cron job](/how-to/firefly-iii/advanced/cron/), Firefly III can alert you about these dates. \n\nIf you enter a number in the \"skip\" field, the subscription will be automatically skipped every X times; a subscription that arrives every 3 months can be entered by filling in \"2\".\n\nThe minimum and maximum amount and the period allow Firefly III to predict for you how much you should expect to spend on these subscriptions. On the frontpage, a little box will tell you how you're doing.  \n\nAfter you create a subscription you are automatically redirected to the page to create a new rule. You can learn [how to manage rules](/how-to/firefly-iii/features/rules/). This new rule is autofilled to trigger on obvious things like the amount of the subscription and the description you entered. Fine-tune the rule so any new transactions will auto-match the rule. \n\nWhen you delete the subscription, transactions associated with the subscription will lose this association but will not be deleted.\n\n\n### The date of a subscription {#the-date-of-a-subscription}\n\n\nWhen you create a subscription you also have to fill in the (first) date you expect the subscription to hit. This date is purely cosmetic and will be used to inform you when the subscription can be expected. For example:\n\n* A monthly subscription, on the 3rd day of the month, will hit: 3 Jan, 3 Feb, 3 Mar, etc.\n* A weekly subscription, starting on 15 Jan, will hit: 15 Jan, 22 Jan, 29 Jan, 5 Feb, etc.\n\nKeep in mind that weekly subscriptions may fall outside your expected range. At some point a weekly subscription will hit 5 times in one month.\n\n\n## Subscription overview {#subscription-overview}\n\n\nIndividual subscriptions will end up looking like this picture:\n\n![Overview of a subscription](/_media/34ca97d1e8e49a56e393.png)\n\nYou see here the most important data of a bill, plus the transactions associated with a bill.\n",
      "documentId": "how-to/firefly-iii/finances/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/subscriptions/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/subscriptions/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/reconcile/index.md",
      "kind": "page",
      "title": "How to reconcile accounts",
      "description": "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 importing a large set of transactions into Firefly III.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reconcile/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reconcile/index.md",
      "file": "how-to/firefly-iii/finances/reconcile/index.md",
      "searchText": "\n# How to reconcile accounts {#how-to-reconcile-accounts}\n\n\nAlthough 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 importing a large set of transactions into Firefly III.\n\n\n## Open the reconciliation page {#open-the-reconciliation-page}\n\n\nOpen the page from either the list of asset accounts, or from a single asset account page.\n\nFrom a single account:\n\n![The button is at the top of the chart](/_media/5cfa180616094d3b3854.png)\n\nFrom the account overview:\n\n![The button is in the menu on the right](/_media/5911086da98d18bf23aa.png)\n\n\n## Start reconciling {#start-reconciling}\n\n\nFirst, enter a date range and set the opening and closing balance as it shows on your bank statement. \n\n![These dates and amounts must match your bank statement.](/_media/a4a838822eb452572bb0.png)\n\nFor example:\n\n* Start date: January 1st, 2018. Balance: € 120\n* End date: January 31st, 2018. Balance: € 788\n\nNext, press **Start reconciling** to continue.\n\nFirefly III will show you the transactions from this range, plus a few earlier and later dated transactions. For each transaction line on your bank statement, find the matching transaction in Firefly III and check the box next to the amount column. Your goal is to verify that your Firefly III transactions exactly match your bank statement. Go over your entire statement and check each transaction in Firefly III.  \n\n- If you find duplicate transactions, you can click on the transaction description to view the transaction, and from that page you can delete the transaction. After deletion, you will be returned to the reconcile page. Previously checked transactions will be checked again.\n- If you find incorrect transactions, you can click the \"edit\" pencil icon, to go into edit mode. After edited, you will be returned to the reconcile view. Previously checked transactions will be checked again.\n\nAfter you have matched all transactions, look at the amount at the top of the screen in the section labeled \"Reconciliation options\". \n\n\n### Amount under \"Reconciliation options\" is less than zero {#amount-under-reconciliation-options-is-less-than-zero}\n\n\nThis means that your Firefly III asset account has less money in it than it should have. Look for duplicate transactions or incorrect amounts and correct them as needed. When you press the \"Store reconciliation\" button you can let Firefly III create an automated transaction to correct this difference. \n\n![When your account is too low on funds, you can allow Firefly III to create a corrective transaction.](/_media/937da85bf8edfda308b9.png)\n\n\n### Amount under \"Reconciliation options\" is more than zero {#amount-under-reconciliation-options-is-more-than-zero}\n\n\nThis means that your Firefly III asset account has more money in it than it should have. Look for missing transactions or incorrect amounts and correct them as needed. When you press the \"Store reconciliation\" button you can let Firefly III create an automated transaction to correct this difference. \n\n![When your account is too full, you can allow Firefly III to create a corrective transaction.](/_media/d57163bf3fc82af8e722.png)\n\n\n### Amount under \"Reconciliation options\" is exactly zero! {#amount-under-reconciliation-options-is-exactly-zero}\n\n\nCongrats! This means that your Firefly III transactions exactly match your bank statement. You can now press \"Store reconciliation\" to mark the checkmarked transactions as reconciled.\n\n![When there is no mismatch between your bank statements and Firefly III, you don't need to do anything.](/_media/0809589a2ed88531f128.png)\n",
      "documentId": "how-to/firefly-iii/finances/reconcile",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reconcile/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reconcile/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/liabilities/index.md",
      "kind": "page",
      "title": "How to manage liabilities",
      "description": "( TODO write me)",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/liabilities/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/liabilities/index.md",
      "file": "how-to/firefly-iii/finances/liabilities/index.md",
      "searchText": "\n# How to manage liabilities {#how-to-manage-liabilities}\n\n\n( TODO write me)\n\nIt depends a bit how you want to \"start\" the liability, but the management\n\n\nFirefly III has two types of liabilities.\n\n1. Liabilities where you owe an amount\n2. Liabilities where somebody owes you money\n\nCredit cards are not considered a liability.\n\n\n\n\n> [!IMPORTANT]\n> Although you can set the interest rate for a liability, Firefly III will not automatically calculate the interest due.\n\n\n\nFirefly III has three types of liabilities:\n\n- Loan\n- Debt\n- Mortgage\n\nOnce created Firefly III keeps track of the amounts for you. Here are the two scenarios and how they work in Firefly III.\n\n\n## You owe money {#you-owe-money}\n\n\nUse the \"new liability\"-form to create a new liability.\n\n\n### Initial amount {#initial-amount}\n\n\nIf necessary, set an amount under \"I owe amount\". The amount you set here will be yours to pay back, but it will not be available in your checking account(s). It's a amount that needs to be paid back, but the money is already spent (for example on a house or a car).\n\nYou can also leave this field empty. In that case, save the account. You will see that the \"amount due\" is zero. The amount you owe must be created by creating a withdrawal from the new liability to an expense account. For example, \"money for new car\", from the liability to the car dealership.\n\n\n### I need to borrow more money {#i-need-to-borrow-more-money}\n\n\nCreate new withdrawals from the liability to your checking account or directly to an expense account (like a shop).\n\n\n### I am paying back money {#i-am-paying-back-money}\n\n\nTransfer money from your checking account into the liability.\n\n\n### Interest payments are increasing the amount due. {#interest-payments-are-increasing-the-amount-due}\n\n\nCreate a withdrawal from the liability to a new expense account that you (could) call \"interest payments\".\n\n\n### Somebody is helping me pay off the loan {#somebody-is-helping-me-pay-off-the-loan}\n\n\nCreate a deposit from your generous benefactor to the liability\n\n\n## I am owed money {#i-am-owed-money}\n\n\nUse the \"new liability\"-form to create a new liability.\n\n\n### Initial amount {#initial-amount_1}\n\n\nIf necessary, set an amount under \"I am owed amount\". The amount you set here will be the amount you are owed. There is no transaction history for this amount, the debt you're owed is just there.\n\nYou can also leave this amount empty, and then create a withdrawal from your checking account into the liability. This represents the amount you are owed. You can also create multiple transactions like this. Each transaction must be coming from one of your asset accounts and go into the liability.\n\n\n### I will loan them more money {#i-will-loan-them-more-money}\n\n\nCreate a withdrawal from your asset account into the liability.\n\n\n### They are paying me back {#they-are-paying-me-back}\n\n\nCreate a deposit from the liability into your asset account.\n\n\n### I am charging interest, or amount I am owed increases for some other reason {#i-am-charging-interest-or-amount-i-am-owed-increases-for-some-other-reason}\n\n\nCreate a deposit from a (new) revenue account into the liability. For example, a newly created revenue account called \"interest payments\".\n\n\n### I am forgiving part of the loan. I do not expect the money back. {#i-am-forgiving-part-of-the-loan-i-do-not-expect-the-money-back}\n\n\nCreate a withdrawal from the liability into a (new) expense account. Call it (for example) \"loan forgiveness\".\n",
      "documentId": "how-to/firefly-iii/finances/liabilities",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/liabilities/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/liabilities/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/recurring/index.md",
      "kind": "page",
      "title": "How to use recurring transactions",
      "description": "Firefly III can automatically create transactions for you, if they follow a tight schedule, like every month, week or year.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/recurring/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/recurring/index.md",
      "file": "how-to/firefly-iii/finances/recurring/index.md",
      "searchText": "\n# How to use recurring transactions {#how-to-use-recurring-transactions}\n\n\nFirefly III can automatically create transactions for you, if they follow a tight schedule, like every month, week or year.\n\nThis feature requires that you know [how to run the cron job](/how-to/firefly-iii/advanced/cron/). If you have set up email correctly, Firefly III will automatically email you an overview of the transactions it has created.\n\n\n## Information for the recurring transaction {#information-for-the-recurring-transaction}\n\n\nA recurring transaction needs meta-data, such as a title and a description. You must also indicate if the recurring transaction is active and whether your rules should apply. The first date the recurring transaction should fire should be a date in the future.\n\n![Mandatory information for a recurring transaction.](/_media/779be1e9ab8149fa3322.png)\n\nThe repetition can be set to the following options:\n\n- Every day.\n- Every week on day X.\n- Every month on day n (1st, 20th).\n- Every month on the x-th X-day.\n- Every year on a specific date.\n\nSome notes apply:\n\n- The x-th X-day means that Firefly III will create the transaction on the first Wednesday or the third Monday every month.\n- If you create a transaction to be repeated on the 29th, 30th or 31st of the month, Firefly III will automatically fall back to the day before if the month isn't long enough.\n\nYou can make Firefly III skip every X occurrences.\n\nIf the date of the transaction should repeat is in the weekend, Firefly III can automatically:\n\n- Skip the transaction altogether.\n- Create the transaction on the Friday before instead. Please note that your recurring transaction will appear to fire a day early.\n- Create the transaction on the Monday after instead. Please note that your recurring transaction will appear to fire a day late.\n- Create the transaction in the weekend.\n\n\n## Information for the transaction itself {#information-for-the-transaction-itself}\n\n\nThese are all the fields you would expect in normal transactions:\n\n![Mandatory information for a recurring transaction.](/_media/1e71e3c57469ba8f6a59.png)\n\n- The type of transaction.\n- The description, the amount (and currency), and the source and destination accounts.\n\nOptional information includes:\n\n- The foreign currency and amount, if you want to.\n- The category, budget, piggy bank and tags.\n\nIf you wish to link a subscription to the transaction, ensure the option to apply rules is checked and that the new transaction would match this rule.\n\n\n## Limitations {#limitations}\n\n\n1. You can't add a dynamic amount to a recurring transaction.\n2. You can't create split transactions.\n",
      "documentId": "how-to/firefly-iii/finances/recurring",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/recurring/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/recurring/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/piggy-banks/index.md",
      "kind": "page",
      "title": "How to use piggy banks",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/piggy-banks/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/piggy-banks/index.md",
      "file": "how-to/firefly-iii/finances/piggy-banks/index.md",
      "searchText": "\n# How to use piggy banks {#how-to-use-piggy-banks}\n\n\nFirefly 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](/explanation/financial-concepts/piggy-banks/).\n\nPiggy banks can be managed from the `/piggy-banks` page on your installation.\n\n\n## Create a piggy bank {#create-a-piggy-bank}\n\n\nIt's always a good idea to keep piggy banks on a dedicated savings account. Let's assume you have one, with €500 on it. \n\nClick on \"Create a new piggy bank\" on the `/piggy-banks` page.\n\n![The screen to create a piggy bank is pretty straight forward.](/_media/a2dfc39a7be9b8c372ef.png)\n\nEnter some details for this piggy bank. The amount is not mandatory, but useful. Here's an example:\n\n- Name: New camera\n- Target amount: €300\n\nYou can save some notes (like a link to the camera webshop) and add attachments if you want to. Use the \"group\" field to group piggy banks together. This is useful if you have a lot of piggy banks.\n\n\n## Manage the piggy banks {#manage-the-piggy-banks}\n\n\nHere are three piggy banks I made:\n\n![The three piggy banks from the example are listed in Firefly III as you can see here.](/_media/72bbf8b4754fe606765b.png)\n\nI can use the \\[+\\] and \\[-\\] buttons to add or remove money from these piggy banks. That way I can divide the money on my savings account between the three goals I have.\n\nOn the bottom of the page, it shows you how much money you have left on your savings account. You can't add more money to your piggy banks than you have on your savings account.\n\n![You can see I have divided almost all my savings over these three piggy banks.](/_media/5c44713ce8ab5037a095.png)\n\n\n## Adding money to or removing money from piggy banks {#adding-money-to-or-removing-money-from-piggy-banks}\n\n\nApart from the \\[+\\] and \\[-\\] buttons, you can also link transfers to a piggy bank. The amount of the transaction will be automatically added to, or removed from the piggy bank.\n\nWhen you create a transfer, you can select a piggy bank from the available list.\n\n- If the piggy bank is linked to the destination account of the transfer, the money from the transaction will be added to then piggy bank.\n- If the piggy bank is linked to the source account of the transfer, the money will be removed from the piggy bank.\n\nThe transfer will _always_ be created. If the piggy bank is full, the piggy bank will not be changed. In other cases, the money will be added until the piggy bank is filled up. Any money left will still be transferred, but will not be added to a piggy bank.\n\n--- \n\nThat's it! [Would you like to know more?](/explanation/financial-concepts/piggy-banks/)\n",
      "documentId": "how-to/firefly-iii/finances/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/piggy-banks/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/piggy-banks/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/finances/reports/index.md",
      "kind": "page",
      "title": "How to read reports",
      "description": "This way you can create the exact cross-section of your finances you need.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reports/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reports/index.md",
      "file": "how-to/firefly-iii/finances/reports/index.md",
      "searchText": "\n# How to read reports {#how-to-read-reports}\n\n\nFirefly III offers a variety of financial reports that can help you keep track of your finances. Each report has a certain scope that you can set to your liking:\n\n* The asset accounts involved.\n* The date range: from 1 day to 20 years\n* Optionally, the budgets, categories or tags\n\nThis way you can create the exact cross-section of your finances you need.\n\n\n## URL options {#url-options}\n\n\nThe URLs for reports look something like this: `/reports/default/1,2,3/20180101/20180131`.\n\n* `default` denotes the report type\n* `1,2,3` is the list of asset accounts included in this report.\n\nIn this example, it is not difficult to see that `20180101` and `20180131` are dates: January 1st, 2018 and January 31st, 2018 respectively.\n\nYou can change these dates to your liking. There are a few magic words available that you can use instead of the exact date:\n\n* `currentMonthStart`. Will return the start of the current month.\n* `currentMonthEnd`. Will return the end of the current month.\n* `currentYearStart`. Will return the start of the current year.\n* `currentYearEnd`. Will return the end of the current year.\n* `previousMonthStart`. Will return the start of the last month.\n* `previousMonthEnd`. Will return the end of the last month.\n* `previousYearStart`. Will return the start of the last year.\n* `previousYearEnd`. Will return the end of the last year.\n* `currentFiscalYearStart`. Will return the start of the current fiscal year, if you have set this in your preferences.\n* `currentFiscalYearEnd`. Will return the end of the current fiscal year, if you have set this in your preferences.\n* `previousFiscalYearStart`. Will return the start of the last fiscal year, if you have set this in your preferences.\n* `previousFiscalYearEnd`. Will return the end of the last fiscal year, if you have set this in your preferences.\n\nYou can also replace `1,2,3` (which denotes the asset accounts to include in the report) with `allAssetAccounts` to include all of your asset accounts in the report.\n\n\n## URL options for budget, category and tag reports {#url-options-for-budget-category-and-tag-reports}\n\n\nThe URLs for these three report types look something like this: `/reports/budget/1,2,3/6,7,8/20180101/20180131`.\n\nAs you can see a new parameter has appeared, `6,7,8` which indicates with objects the report should be about. These could refer to budgets, tags or categories, depending on the type of report you're viewing.\n\nYou can replace this second parameter with `allBudgets`, `allCategories` or `allTags` in order to include all the objects in the report.\n\n\n## Available reports {#available-reports}\n\n\nThe reports that are currently available are:\n\n\n### Default financial report {#default-financial-report}\n\n\nThe default report gives you a general overview of your finances. It lists your account balances with summaries, plus your expenses and incomes. It will also list your budgets, categories and subscriptions, giving you insight in your current financial situation. You can click on the screenshot below for a large version.\n\nEach table you see in the screenshot can be sorted by name, by amount, in reverse, etc. The charts have little hover-texts for added clarity and the (i)-buttons will give show more detailed information.\n\n\n[![Default financial report](/_media/5ee074efd6de21885116.png)](/_media/a37caf7373e836d05c1d.png)\n\n\n### Audit report {#audit-report}\n\n\nThe audit report is meant to give you an exact overview of an asset account (or multiple). For each asset account it will list the start and end balance, and it can show every available field in a table, if you want to. It will also list the before / after balance for each transaction. This should make it easy to find possible mistakes in your administration. You can click on the screenshot below for a large version.\n\n[![Audit report](/_media/cd497255cb2870f3f31a.png)](/_media/68ff7801001aaae049af.png)\n\n\n### Expense/revenue report {#expenserevenue-report}\n\n\nThe expense/revenue report is meant for expense and revenue accounts that share the same name. Take for example your local Tax Department. You pay taxes, but perhaps you receive money back as well. Or when you work in retail, you might be able to buy stuff at a discount. This report shows you an overview of such accounts. You can click on the screenshot below for a large version.\n\n[![Expense + revenue report](/_media/8e89a15a47477462805b.png)](/_media/81778f5c7eb0fd0dbd29.png)\n\n\n### Budget report {#budget-report}\n\n\nThis report shows you a detailed overview for the selected budgets *and* the selected account, allowing you to see how well you're doing for each selected budget. This is especially useful to see where you're spending your money, what the trend line is and if your budget limits are actually having any effect.\n\nPart of this information is also available on the default budget pages, and your front page. You can click on the screenshot below for a large version.\n\n[![Budget report](/_media/b2c2b921bd68ce0b6f4a.png)](/_media/569feb9d11f56e321945.png)\n\n\n### Category report {#category-report}\n\n\nThis report is the same as the budget report but focuses on your categories. It can also include income, which can be very useful. Use this report to see on which specific things you unexpectedly spend a lot of money. Likewise, since it includes incomes, it can also be used to see if that raise you have received actually amounted to anything, after taxes. You can click on the screenshot below for a large version.\n\n[![Default category report](/_media/e753bdd80f26cabdb186.png)](/_media/d8a804ec546cac6bfd11.png)\n\n\n### Tag report {#tag-report}\n\n\nThis report is the same as the category report but focuses on your tags. Use this report to see on which specific things you unexpectedly spend a lot of money. Likewise, since it includes incomes, it can also be used to see if that raise you have received actually amounted to anything, after taxes. You can click on the screenshot below for a large version.\n\n[![Tag report](/_media/55c4a0ea1b8fd50e0391.png)](/_media/ca98e99e6abbdd1cd1bd.png)\n",
      "documentId": "how-to/firefly-iii/finances/reports",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reports/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/finances/reports/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/multi-user/index.md",
      "kind": "page",
      "title": "How to make Firefly III multi-user?",
      "description": "Firefly III supports an unlimited amount of users, who all have their own financial administration, completely separated from other users.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/multi-user/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/multi-user/index.md",
      "file": "how-to/firefly-iii/features/multi-user/index.md",
      "searchText": "\n# How to make Firefly III multi-user? {#how-to-make-firefly-iii-multi-user}\n\n\nFirefly III supports an unlimited amount of users, who all have their own financial administration, completely separated from other users.\n\nThis is disabled by default: most users install Firefly III for themselves, so as a security measure registration is blocked after the first user.\n\n\n## How do I enable multi-user mode? {#how-do-i-enable-multi-user-mode}\n\n\nThe first user that registers itself automatically becomes the \"owner\". This user can enable multi-user mode.\n\nTo enable registrations again, go to `/settings` and click \"Configuration options for Firefly III\". Then, unselect \"Disable user registration\" and press \"Store configuration\".\n\n\n## Can I share my administration with other users? {#can-i-share-my-administration-with-other-users}\n\n\nAt the moment, you cannot. Sorry about that. I am working on a sharing model where you can share your administration with other users, and give them read/write rights to different parts of it. This is a big project and will take a while.\n",
      "documentId": "how-to/firefly-iii/features/multi-user",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/multi-user/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/multi-user/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/rules/index.md",
      "kind": "page",
      "title": "How to use rules",
      "description": "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\".",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/rules/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/rules/index.md",
      "file": "how-to/firefly-iii/features/rules/index.md",
      "searchText": "\n# How to use rules {#how-to-use-rules}\n\n\nFirefly 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\".\n\nThis is especially useful when you're importing data, and you wish all transactions to be updated at once. Or perhaps, you are too lazy to set the correct budget and category all the time, so you make a rule to do this for you.\n\nRules are divided in rule groups. Each rule group has rules in a specific order.\n\n\n## Triggers {#triggers}\n\n\nA rule must spring into action at the right time! This is decided by triggers that you can set yourself. Here are some notable rule triggers that people use often:\n\n* When a transaction is created\n* When the description is something specific\n* When the amount is more than *X*.\n* When the budget is *X*.\n\nFor a full list of triggers please check out [this reference of all rule triggers](/references/firefly-iii/rule-triggers/).\n\nRules can be set to be \"strict\" or not. If a rule is set to be strict, ALL triggers must match for the rule to fire. If a rule is not strict, ANY trigger is enough.\n\nThis can be useful if you wish to match multiple descriptions in one same rule, for example. If your transactions are described \"groceries\" or \"went shopping\" or \"got food\" then a *non-strict* rule could match all of them by adding 3 triggers with different content.\n\nTriggers can be inverted, in which case they do the exact opposite.\n\n\n## Actions {#actions}\n\n\nWhen the triggers are hit (either ALL or ANY, see the \"strict\" option), Firefly III will execute the associated rule actions. There are many actions available. Notable ones are:\n\n* Change the budget, category, tag(s), description, amount\n* Set a new description\n* Change the source or destination account\n\nCombined, this gives you a lot of power over your financial data. There is [a reference to the full list of actions](/references/firefly-iii/rule-actions/).\n\nIf the list of actions is not enough, you can use the [expression engine](/how-to/firefly-iii/features/expressions/) to create more complex actions.\n\nYou cannot fire other rules from a rule.\n\nYou can refer to a piggy bank from a rule action, so the transaction's amount will be added to (or removed from) the piggy bank. This will only work when the transaction is a transfer.\n\n\n## Stop processing? {#stop-processing}\n\n\n\n### Stop processing other rules {#stop-processing-other-rules}\n\n\nWhen you create a new rule, you can set an option called \"stop processing\". If you set it, and the rule is triggered, other rules in the group will NOT be processed anymore.\n\nExample: you have three rules in a group to add the tag \"Groceries\" to your groceries. One for each store you frequent. Once the first rule has triggered, you no longer need to check the other two rules.\n\n\n### Stop processing other triggers {#stop-processing-other-triggers}\n\n\n\n\n> [!IMPORTANT]\n> This only applies to \"non-strict\" rules, because for strict rules, all triggers need to be hit anyway.\n\n\n\nFor any trigger in a non-strict rule, you can also set the \"stop processing\" option. Non-strict rules search for each trigger one by one, independently of one another, and pool the results together. If you search for transactions that start with \"A\" and transactions that start with \"B\", two searches are done and the results are presented as one list.\n\nIf you set \"stop processing\" on any trigger, Firefly III will stop the search as soon as the first trigger finds something. It will not continue with the other triggers unless there are no transactions at all that match the first trigger.\n\nFor example, if you create a rule that searches for transactions that start with \"A\" and transactions that start with \"B\" and you set the first trigger to \"stop processing\", no transactions that start with \"B\" will ever be found, if there are still transactions that start with \"A\".\n\n\"Stop processing other triggers\" may lead to unpredictable results. The rule may (not) work as expected when you test it. But these kinds of rules, applied to newly created transactions do not check *other* transactions. \n\nIn many cases this means that a rule that does not work on multiple transactions, *will* work on a newly created transaction. This is because the rule is applied to the newly created transaction individually, and not to a group of transactions. \n\n\n### Stop processing other actions {#stop-processing-other-actions}\n\n\nFor each action, you can set \"stop processing\" as well. When you do, if the action changes a transaction, any actions after the current one will not fire.\n\n\n## Apply rules {#apply-rules}\n\n\nYou can apply your rules to existing transactions. On the rule-overview (page ``/rules``), either use the \"on/off\"-icon or the ellipsis menu in a rule group to apply entire rule groups or individual rules to your transactions. See for some screenshots below.\n\n\n## Boolean logic {#boolean-logic}\n\n\nThis feature of Firefly III is pretty advanced, even if I say so myself. It does not support complicated rules. Rules like \"the budget must be Groceries and the shop must be A or B\" combine different operators (\"and\" and \"or\"). This will not work.\n\n\n## Errors {#errors}\n\n\nRule actions may fail. For example, if a transaction has no category, a rule action to remove the category fails. Firefly III does not report this in the user interface because rules are often executed asynchronously. You can check the logs for errors.\n\nIf you set up a [Slack or Discord notification channel](/how-to/firefly-iii/advanced/notifications/), you will get these rule specific errors in your Slack or Discord channel.\n\n\n## Can I use a rule (action) to create new transactions? {#can-i-use-a-rule-action-to-create-new-transactions}\n\n\nNo. Please use [webhooks](/how-to/firefly-iii/features/webhooks/) for that.\n\n\n## Screenshots {#screenshots}\n\n\n![A new rule can be given some basic information.](/_media/2da50273cb0a98addd0d.png)\n\n![First you would set up the triggers for the new rule](/_media/6ff871c6187724a3f4db.png)\n\n![Then decide on the actions to take.](/_media/d572f739a8d13f57c838.png)\n\n![Option to run a rule on transactions.](/_media/d5218897cb180adcb814.png)\n\n![Option to run a rule group on transactions.](/_media/c1fe7f18ebd6d08ae261.png)\n\n\n",
      "documentId": "how-to/firefly-iii/features/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/rules/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/rules/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/expressions/index.md",
      "kind": "page",
      "title": "How to use expressions in rules?",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/expressions/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/expressions/index.md",
      "file": "how-to/firefly-iii/features/expressions/index.md",
      "searchText": "\n# How to use expressions in rules? {#how-to-use-expressions-in-rules}\n\n\n\n\n> [!WARNING]\n> **Use of Expressions**\n>\n> This feature requires 6.1.20 or later and must be manually enabled in 'System Settings - FireFly III Configuration - Enable expression engine' with versions > 6.7.x\n\n\n\n\n## Introduction {#introduction}\n\n\n\nOnce you've learned [how to use rules](/how-to/firefly-iii/features/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.\n\nThanks to GitHub user [@michaelhthomas](https://github.com/michaelhthomas) the rule actions now support the Symfony expression engine. This means that you can write a complicate \"expression\" that result in a new piece of text, or a new value. Depending on the action that you choose, you can do some pretty cool things.\n\n\n\n> [!IMPORTANT]\n> **Full syntax**\n>\n> The full syntax of the expression language is documented in the [Symfony documentation](https://symfony.com/doc/current/reference/formats/expression_language.html).\n\n\n\nYou can read about the fields you can use in the [expression reference](/references/firefly-iii/rule-expressions/).\n\n\n## Basics {#basics}\n\n\nFirst the basics. A rule action contains a value, and the value will be set in the transaction. Here's an example. It does **not** use the expression engine:\n\n![Basic action](/_media/03380bf4b8b544159581.png)\n\nThis rule action will set the category of the transaction to \"Groceries\". This is pretty straightforward.\n\nAn expression starts with `=`. This tells Firefly III that you're about to write an expression. The expression follows.\n\nHere's a simple example that sets the notes of the transaction to whatever the description is.\n\n![Notes action](/_media/9970d2466b45ee3c7a8f.png)\n\n`=description`\n\n\n## Mathematics {#mathematics}\n\n\nYou can use some simple mathematics, for example on the `amount`-field, to subtract taxes or fees. Here's an action to remove Dutch sales tax from a transaction, which is 21% in most cases:\n\n![Sales tax](/_media/b28887338132c1f19ae8.png)\n\n`=amount-(amount/121)*21`\n\n\n## Text {#text}\n\n\nYou can join text together using the tilde. This allows you to join two fields together, or add a prefix or suffix to a field. Here is the description added to the notes _twice_.\n\n![Twice](/_media/aa417ab116e2de66e40a.png)\n\n`=description~description`\n\n\n## Cutting text and text length {#cutting-text-and-text-length}\n\n\nYou can use `strlen` to get the length of a value, and you can use `substr` to cut a part of a value out. You can find a particular piece of text using `strpos`. \n\n![Strlen](/_media/87b4d4d76d88f68d726e.png)\n\n`=strlen(description)`\n\nThis method example cuts of the last four characters of the description:\n\n![Last four](/_media/4dde20cd2cf8d658888e.png)\n\n`=substr(description, 0, -4)`\n\nThis allows for more useful combinations. Some of my own transactions always end with the name of the destination account (so it's double). I can cut that off using:\n\n![Last four](/_media/bc9262e7b81a77df8380.png)\n\n`substr(description, 0, strlen(description) - strlen(destination_account_name))`\n\nYou can also find a particular piece of text in your description, and remove the rest. For example, if an expense is made through a third party payment provider the destination account name could be \"Webshop via Adyen\". To fix that, use:\n\n`=substr(destination_account_name, 0, strpos(destination_account_name,'via'))`\n\nYou see how `strpos` uses two arguments. The field it searches in, and the text to search for. \n\n\n## Other methods {#other-methods}\n\n\nThere are no other methods yet, but they can be added. Are you looking for anything in particular? [Let me know](/explanation/support/).\n",
      "documentId": "how-to/firefly-iii/features/expressions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/expressions/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/expressions/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/webhooks/index.md",
      "kind": "page",
      "title": "Webhooks",
      "description": "A webhook is a custom callback. Triggered by events in Firefly III a message will be sent to a URL of your choice.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/webhooks/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/webhooks/index.md",
      "file": "how-to/firefly-iii/features/webhooks/index.md",
      "searchText": "\n# Webhooks {#webhooks}\n\n\nA webhook is a custom callback. Triggered by events in Firefly III a message will be sent to a URL of your choice.\n\n\n## Enable webhooks {#enable-webhooks}\n\n\nWebhooks need to be enabled before they work. Go to `/settings/configuration` to enable them.\n\n![Creating a new webhook](/_media/bf65572588c2dca6579e.png \"Create a new webhook\")\n\n\n## Triggers {#triggers}\n\n\nThere are a bunch of triggers for webhooks in Firefly III:\n\n- When a transaction is created, updated or removed.\n- When a budget is created, updated or removed\n- When a budget amount is set or changed\n- When any of the above happens (\"After any event\")\n\nA webhook can respond to multiple triggers. BUT, you cannot combine the  \"After any event\" with other triggers, it would have to be the only trigger. I hope this makes sense, because \"After any event\" already includes everything.\n\n\n## Responses {#responses}\n\n\nWhen triggered, Firefly III will respond by sending a data package to the URL of your choice. The response can be configured, depending on the trigger.\n\nA webhook can only send one thing. If you want multiple responses to be sent for the same webhook, you must set up multiple webhooks.\n\nPossible options are:\n\n- Transaction details\n- Account details\n- Budget details\n- Budget amount details\n- Relevant details (see ahead for more information)\n\n\n### Relevant details {#relevant-details}\n\n\nIf you select \"Relevant details\" as the response, Firefly III will send the \"relevant\" data for the trigger. This is up to Firefly III to decide. For example, if you trigger on a transaction creation, the response will be the transaction itself. If you trigger on a budget, the response will be the budget itself.\n\nIt is mandatory to select \"Relevant details\" when you select \"After any event\" as the trigger. This is because \"After any event\" can trigger on many different events, and Firefly III cannot know what you want to receive. Therefore, it will always send the relevant details for the event that triggered the webhook.\n\nIt is also mandatory to select \"Relevant details\" when you combine certain webhook triggers. For example, when you combine budget and transaction events in a single webhook, you must select \"Relevant details\". Firefly III will warn you when this is the case. \n\nYou cannot combine \"Relevant details\" with other responses. It must be the single response selected.\n\nRelevant details consist of:\n\n- For transaction related events: the transaction itself\n- For budget related events: the budget itself\n- For budget amount related events: the \"budget limit\", i.e. the amount for that particular period.\n\n\n### Transaction details {#transaction-details}\n\n\nYou can choose to receive the transaction details for transaction related events.\n\n\n### Account details {#account-details}\n\n\nYou can choose to receive the account details for account AND transaction related events.\n\n\n## Delivery {#delivery}\n\n\nAll webhook responses will be delivered in JSON. This is the only option:\n\n- JSON\n\n\n## Create or edit webhooks using the API {#create-or-edit-webhooks-using-the-api}\n\n\nYou can manage webhooks using [the webhook API endpoints](/api/#tag-webhooks) or on the page `/webhooks/index`.\n\n\n## Webhook secret {#webhook-secret}\n\n\nEach webhook comes with a secret when created. The secret is used to generate the signature (see below). You can regenerate the secret, but you can't set a value yourself.\n\n\n## Webhook limits {#webhook-limits}\n\n\nYou must give webhooks a unique title.\n\nIt's not possible to send *two* or more responses *at the same time*, for example the transactions AND the accounts in response to ONE trigger. To do this, you must create two separate webhooks. These will have two separate secrets.\n\n\n## Payload {#payload}\n\n\nWhen a webhook delivers its payload you can expect (more or less) the following result. The signature is important and explained later on.\n\n\n### Headers {#headers}\n\n\nThese are the headers Firefly III will include with each submitted webhook. The version will match your Firefly III version. The signature has been shortened for clarity.\n\n```\nUser-Agent = FireflyIII/5.5.0\nSignature = t=1610738765,v1=d62463af1dcdcc...\nAccept = application/json\nContent-Type = application/json\n```\n\n\n### Body {#body}\n\n\nThe body will be something like this.\n\nThe UUID is unique for each webhook message. You can use it for debug purposes. The user ID matches the user who created the webhook, and the trigger + response fields tell you why the webhook was fired and what the content of the `content` field is. The webhook message also contains the original URL of the webhook.\n\nThe `content` block corresponds to the `response` value. It's either the transaction, an array of accounts or something else entirely. This depends on the configuration of the webhook.\n\nNote that the result sent to you by Firefly III isn't formatted as nicely. A webhook message from Firefly III isn't indented. Note also that in this example some parts of the actual `content` have been cut away to save space.\n\n```json\n{\n\t\"uuid\": \"27db119a-c971-423f-9faf-cdae47367fc8\",\n\t\"user_id\": 1,\n\t\"trigger\": \"TRIGGER_STORE_TRANSACTION\",\n\t\"response\": \"RESPONSE_TRANSACTIONS\",\n\t\"url\": \"http:\\/\\/example.com\\/\",\n\t\"version\": \"v1\",\n\t\"content\": {\n\t\t\"id\": 246,\n\t\t\"created_at\": \"2021-01-15T20:26:04+01:00\",\n\t\t\"updated_at\": \"2021-01-15T20:26:04+01:00\",\n\t\t\"user\": 1,\n\t\t\"group_title\": null,\n\t\t\"transactions\": [{\n\t\t\t\"user\": 1,\n\t\t\t\"transaction_journal_id\": 251\n\t\t}],\n\t\t\"links\": [{\n\t\t\t\"rel\": \"self\",\n\t\t\t\"uri\": \"\\/transactions\\/246\"\n\t\t}]\n\t}\n}\n```\n\n\n\n### Signature {#signature}\n\n\nThis is a typical signature string:\n\n```\nt=1610738765,v1=d62463af1dcdcc7b5a2db6cf6b1e01d985c31685ee75d01a4f40754dbb4cf396\n```\n\nThe signature comes in two parts, a timestamp (`t`) and a versioned signature hash (`v`). The timestamp is prefixed by `t=`. Each signature is prefixed by a scheme. Schemes start with `v`, followed by an integer. Currently, the only valid live signature scheme is `v1`. Therefore, the signature is prefixed by `v1=`.\n\nThe signature is generated using the HMAC method. The signed string is created by concatenating:\n\n* The timestamp (as a string)\n* The literal character `.` (a dot)\n* The non formatted JSON body of the request.\n\nExample: `123456.{\"some\":\"json\"}`.\n\nThe concatenated string is hashed using SHA-3 (256 bits). The shared secret key used for generating the HMAC key is the `secret` of the webhook itself.\n\nA useful little script to verify webhooks [can be found on GitHub](https://gist.github.com/JC5/b8bedee09a7cb81f55e27149058e8c72).\n",
      "documentId": "how-to/firefly-iii/features/webhooks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/webhooks/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/webhooks/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/search/index.md",
      "kind": "page",
      "title": "How to use the search",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/search/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/search/index.md",
      "file": "how-to/firefly-iii/features/search/index.md",
      "searchText": "\n# How to use the search {#how-to-use-the-search}\n\n\nYou 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. \n\n\n## A basic search {#a-basic-search}\n\n\nEnter a word (or words), and Firefly III will search in the descriptions of transactions for what you're looking for.\n\n![A basic search](/_media/444b84c526f5143d2ced.png)\n\nUse `\"a query with spaces\"` if you need to search for things with spaces in them.\n\n\n## Finding specific accounts {#finding-specific-accounts}\n\n\nYou can use `from:` and `to:` if you need to find transactions from or to a specific account. For example:\n\n![A search for transactions from a specific account](/_media/c39ecad99e48efc904b0.png)\n\nYou can also search for amounts and dates. Here are two examples:\n\n`less:20`\n\n![A search for transactions of less than 20](/_media/ca13729d29c9cc996776.png)\n\n`before:2024-01-01`\n\n![A search for transactions before 2024](/_media/36a18c2e628650a56292.png)\n\n\n## Combining search options {#combining-search-options}\n\n\nYou can of course combine all of these options in any way you want.\n\n\n## Which options are there? {#which-options-are-there}\n\n\nCheck out the [full reference to the search options](/references/firefly-iii/search/).\n",
      "documentId": "how-to/firefly-iii/features/search",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/search/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/search/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/currencies/index.md",
      "kind": "page",
      "title": "How to use currencies",
      "description": "Firefly III has support for multiple currencies.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/currencies/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/currencies/index.md",
      "file": "how-to/firefly-iii/features/currencies/index.md",
      "searchText": "\n# How to use currencies {#how-to-use-currencies}\n\n\nFirefly III has support for multiple currencies.\n\nSee also:\n\n- [Explanation: exchange rates](/explanation/financial-concepts/exchange-rates/)\n\nMost currencies are disabled by default, meaning that you cannot use just any currency when creating asset accounts or transactions. You must enable them first.\n\nUnder Options &gt; Preferences you will find the \"Currencies\" page. When you are an admin, you will see the button \"Create a new currency\". You should enter some details such as the name, the symbol of the currency and of course the currency code (preferably according to the [ISO 4217](https://www.currency-iso.org/dam/downloads/lists/list_one.xml) standard).\n\nCurrencies have decimal places. Most have 2, like the Euro. Notable exceptions are most cryptocurrencies (8 to 12) and the Mauritanian ouguiya (no decimals). Firefly III supports up to 8 decimals.\n\nPlease note that each currency needs:\n\n- A symbol, such as $ or € or something else.\n- A code, such as EUR or USD or something you make up.\n- A name, of course.\n\nCurrencies tend to have 2 decimal places. You should check out Wikipedia for more information about your preferred currency, if you are unsure. If you want to know what the values are for your currency, check out [this list of currencies](https://github.com/xsolla/currency-format/blob/master/currency-format.json) on GitHub. New currencies are enabled by default.\n\n\n\n## How-to add a currency {#how-to-add-a-currency}\n\n\nNew currencies added through this form will be enabled for use.\n\n![This screen allows you to create a new currency. Pretty straight-forward.](/_media/829375c67c9643e5e95d.png)\n\n\n## Set the primary currency {#set-the-primary-currency}\n\n\nFirefly III support multiple currencies, and each administration has a primary currency. When you install Firefly III this is the Euro. You can change this if you want to.\n\nGo to Options > Financial administrations (or `/administrations`) and under Actions, click \"Edit\". Here you can set the primary currency for your current financial administration.\n\n![In this instance of Firefly III, the primary currency is the British Pound.](/_media/7422350c3d61cedd304f.png)\n\nOn the overview of your currencies at `/currencies` you can see ALL currencies (disabled en enabled):\n\n![In this instance of Firefly III, the primary currency is the British Pound.](/_media/ca7cce61f32edd518676.png)\n\n\n## Set currency for asset accounts {#set-currency-for-asset-accounts}\n\n\nAsset accounts have one main currency. My personal bank accounts are in Euro. But I have a credit card in USD. You can set this when you create or edit an asset account. This is important when you create or import transactions.\n\n![Each account has its own currency.](/_media/495ca1ffc44951f3ba28.png)\n\n\n## Creating transactions {#creating-transactions}\n\n\nWhen you try to create a transaction in Euro's on an asset account that in US Dollars, you must set the amount in both USD and EUR.\n\n![When you withdraw an amount in a &quot;foreign&quot; currency, Firefly III needs to know the amount in the primary currency.](/_media/8f05330f0e75e6d3cd43.png)\n\n\n## Creating transfers {#creating-transfers}\n\n\nWhen you create a transfer between an account in EUR and USD (or other currencies) you must also indicate the amount transferred in both currencies.\n\n![Likewise when you transfer money between two asset accounts, both currencies must have a monetary value.](/_media/47b937a1fbaf0b067abc.png)\n",
      "documentId": "how-to/firefly-iii/features/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/currencies/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/currencies/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/cli/index.md",
      "kind": "page",
      "title": "CLI / Command Line Interface",
      "description": "Firefly III has a few commands you can use. See this reference to a list of commands.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/cli/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/cli/index.md",
      "file": "how-to/firefly-iii/features/cli/index.md",
      "searchText": "\n# CLI / Command Line Interface {#cli--command-line-interface}\n\n\nFirefly III has a few commands you can use. See [this reference to a list of commands](/references/firefly-iii/cli/).\n\n\n## Docker {#docker}\n\n\nRun the following command on your command line, and replace COMMAND:COMMAND with the actual command from the list below.\n\n```bash\ndocker exec -it $(docker container ls -a -f name=firefly --format=\"{{.ID}}\") php artisan COMMAND:COMMAND\n```\n\nIf this doesn't work, replace the `$(..)` part with your actual Docker container ID:\n\n```bash\ndocker exec -it abcde php artisan COMMAND:COMMAND\n```\n\n\n## Self-managed {#self-managed}\n\n\nRun:\n\n```bash\ncd /var/www/html/firefly-iii\nphp artisan COMMAND:COMMAND\n```\n\n\n## Third-party {#third-party}\n\n\nMost third party systems, like Heroku, don't allow you to do this.\n",
      "documentId": "how-to/firefly-iii/features/cli",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/cli/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/cli/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/features/api/index.md",
      "kind": "page",
      "title": "How to use the API",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md",
      "file": "how-to/firefly-iii/features/api/index.md",
      "searchText": "\n# How to use the API {#how-to-use-the-api}\n\n\nThe 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](/api/).\n\nTalking to the API can be done with any tool like Postman or cURL. Keep in mind that the [demo site](/explanation/firefly-iii/about/demo/) of Firefly III will probably block your requests (this is to protect against script kiddies). Your own installation should work fine, however.\n\nFirefly III offers the following end points that can be used in applications that support the OAuth2 workflow.\n\n* `/oauth/authorize`\n* `/oauth/token`\n\n\n## Authentication {#authentication}\n\n\nThe API uses the OAuth2 workflow. You need to create OAuth2 Clients on the `/profile` when logged in.\n\n\n## Create an OAuth2 client {#create-an-oauth2-client}\n\n\nClick \"Create New Client\" to create a new Client. Give it a name and enter the correct callback URL. If it all goes well, a new entry will appear in the list. It shows a Client ID and a secret. The secret can be exchanged for an access token. The access token is then used to access the API.\n\n\n### Confidential {#confidential}\n\n\nSome clients, like the data importer, can't keep a secret. So, if you uncheck the \"confidential\"-box, the client comes without a secret. This is necessary for the data importer but some other clients also need this.\n\nFor the data importer, uncheck the \"confidential\" checkbox. This is not necessary for other clients (that I know of).\n\n![This is the correct client ID](/_media/fee634e33c13b313fb06.png)\n\n\n### Callback URL {#callback-url}\n\n\nIt is very important that the callback URL is correct. For the data importer, this is the correct callback URL:\n\n```\nhttp://[DATA IMPORTER]/callback\n```\n\nSome common examples include:\n\n* [http://172.16.0.2/callback](http://172.16.0.2/callback) (172.16 is a common IP range for Docker hosts)\n* [https://data-importer.home/callback](https://data-importer.home/callback) (Some users have fancy local addresses. Notice the TLS)\n* [http://10.0.0.15/callback](http://10.0.0.15/callback) (10.0.0.x is often used when using Vagrant)\n\nFor the data importer, you must always add `/callback` or you'll run into weird errors later.\n\nOther clients may have other callback URLs.\n\n\n### Result {#result}\n\n\nHere you see two OAuth Clients in my profile:\n\n![Your OAuth2 Clients as they would be visible in your profile](/_media/29786d070a5472bcc6cd.png)\n\nHere you see how Postman would use the secret to get an access token. What you can build in OAuth2 is out of the scope of this document.\n\n![Here is the OAuth2 screen from Postman.](/_media/51ac4bac9f7f9aa6ce86.png)\n\n\n## Personal Access Tokens {#personal-access-tokens}\n\n\nSome technical background. If your application can't or won't use OAuth2 you must generate a Personal Access Token. You can generate your own Personal Access Token on the Profile page. Login to your Firefly III instance, go to \"Options\" > \"Profile\" > \"OAuth\" and find \"Personal Access Tokens\".\n\nClick on \"create new token\":\n\n![Click the right button.](/_media/afbb2cf7181aa79b3e5a.png)\n\nGive your token a name you recognize:\n\n![Give your token a name you recognize.](/_media/e6d38a6d7252b3d47b8b.png)\n\nCopy the entire token. Yes, it's very long!\n\n![Copy the entire token.](/_media/ecd6177d26fc552dfed4.png)\n\nTo use the token you have to pass an `Authorization: Bearer <token>` HTTP header. As an example in curl:\n\n```bash\ncurl -X GET 'https://your-domain/api/v1/webhooks' \\\n  -H 'accept: application/vnd.api+json' \\\n  -H 'Authorization: Bearer [Personal Auth Token]' \\\n  -H 'Content-Type: application/json'\n```\n\n\n## It doesn't work {#it-doesnt-work}\n\n\nMany things can go wrong when you try to talk to the API. Even the data importer doesn't always work on the first try.\n\nMake sure you have a header `Accept: application/json`, or Firefly III will not respond with JSON (or even the correct response header).\n\nIf you are trying to get the data importer to work, please [check out the FAQ](/references/faq/data-importer/general/).\n\nFor other questions, use [the support page](/explanation/support/) to contact me or open a discussion on GitHub.\n",
      "documentId": "how-to/firefly-iii/features/api",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md"
        }
      ]
    },
    {
      "id": "how-to/firefly-iii/development/translations/index.md",
      "kind": "page",
      "title": "Translating Firefly III",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/development/translations/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/development/translations/index.md",
      "file": "how-to/firefly-iii/development/translations/index.md",
      "searchText": "\n# Translating Firefly III {#translating-firefly-iii}\n\n\nFirst 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.\n\n\n## Target language {#target-language}\n\n\nEnsure the language you want to translate in is listed [on this page](https://crowdin.com/project/firefly-iii). If not, [see the instructions on the Support page](/explanation/support/).\n\nIf you contact me, tell me what your language is called _in your language_. For example, Dutch in Dutch is `Nederlands`.\n\n\n## Translate online {#translate-online}\n\n\nCrowdin has a pretty fancy user interface for translating Firefly III texts. This works pretty well for most people, but you lack context: you don't know where your text is going to end up. But this works for most text.\n\n\n## Translate offline {#translate-offline}\n\n\nYou can hack your installation of Firefly III to make it show your language, even if it's not officially enabled yet.\n\n\n### Enable the language {#enable-the-language}\n\n\nFirst, open `app/config/firefly.php` in your favorite text editor and search for the languages' configuration. You should see a bunch of languages listed in a row:\n\n![Enabled languages](/_media/03f946cb1eb6a80b9428.png)\n\nBelow that, a list of languages that are not enabled yet. Each line is preceded by `//`. If it's not there yet, you can add it.\n\n![Disabled languages](/_media/07bde19292bac8e4d65a.png)\n\nRemove the `//` to enable the language of your choice.\n\n![Klingon can now be translated](/_media/afd033947239bb076ab3.png)\n\nYou can now select this language in your settings.\n\n![Klingon can now be translated](/_media/57faa961606b967da019.png)\n\n\n### Download the right files {#download-the-right-files}\n\n\nEverything in Firefly III will still be in English. You need to download a zip file with the correct files in them, and place it in your Firefly III installation directory.\n\nGo to [Crowdin](https://crowdin.com/project/firefly-iii), select your language and download a zip file of your language.\n\n![Download zip file](/_media/30be587b17f79bfbc3f5.png)\n\nIn the zip file, you'll find a directory called `resources/lang/xx_XX` where `xx_XX` is your language code. The PHP files you find in that directory inside the zip file must be extracted to `firefly-iii/resources/lang/xx_XX`. Change `xx_XX`, of course.\n\n![Zip file structure](/_media/b1bc8cdd32e9b21d82c5.png)\n\nOnce the files are in place, you can start editing them directly. If you refresh your instance of Firefly III, the text should be translated instantly.\n\n![The very first translation](/_media/5272f235cb75e0922cba.png)\n\n![The result in Firefly III](/_media/6bd1177344d3dd696933.png)\n\nOnce you're done with a file, send the file [to me](/explanation/support/), so I can upload the results to Crowdin.\n",
      "documentId": "how-to/firefly-iii/development/translations",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/development/translations/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/firefly-iii/development/translations/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/installation/docker/index.md",
      "kind": "page",
      "title": "How to install using Docker",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/docker/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/docker/index.md",
      "file": "how-to/data-importer/installation/docker/index.md",
      "searchText": "\n# How to install using Docker {#how-to-install-using-docker}\n\n\nFirefly 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.\n\nThe easiest way to install them is using \"Docker compose\", which is a Docker tool that allows you to define and run multi-container Docker applications. With Docker compose, you use a YAML file to configure your application's services. Then, with a single command, you create and start all the services from your configuration.\n\nThis guide will assume you'll want to install both Firefly III and the Data Importer. If you already have a Firefly III installation, and you wish to expand it with the data importer, do not worry. You can follow this guide again and reinstall Firefly III. You will point to the same data volumes and the same databases, so nothing will be lost.\n\nThe YAML file and all necessary configuration are provided online for your convenience.\n\nIf you happen to include any existing data from Firefly III, please [back this data up first](/how-to/firefly-iii/advanced/backup/).\n\nIf you have questions, please refer to [the Docker FAQ](/references/faq/docker/) or contact me using the instructions from the [support page](/explanation/support/).\n\n\n## Docker Compose {#docker-compose}\n\n\n\n### Download files {#download-files}\n\n\nGrab the **[docker-compose-importer.yml](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose-importer.yml)** from GitHub. Download the raw file and store it in a directory of your choice as `docker-compose.yml`.\n\nThen, download the configuration files:\n\n- Download the `.env.example` file for Firefly III [from the Firefly III repository](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example). Save the raw file as `.env` next to the docker compose file.\n- Download the `.env.example` file from the [Data Importer repository](https://raw.githubusercontent.com/firefly-iii/data-importer/main/.env.example) and save it as `.importer.env` next to the other files.\n- The final file (`database.env`) contains the database variables and can be downloaded from [the Docker repository](https://raw.githubusercontent.com/firefly-iii/docker/main/database.env). Save it as a new file called `.db.env`.\n\n\n### Edit files {#edit-files}\n\n\nIf you save all example files and change nothing, it will NOT YET work. You must do a few things:\n\n1. Change `DB_PASSWORD` in `.env` to something else. Pick a nice password (some special characters such as $ may need to be escaped e.g. $$).\n2. Also change `MYSQL_PASSWORD` in `.db.env` to the SAME value\n3. Change `FIREFLY_III_URL` in `.importer.env` to `http://app:8080`\n4. Change `VANITY_URL` in `.importer.env` to the URL you use to reach Firefly III. For example: `http://localhost` (this is probably different in your case).\n5. Set `TRUSTED_PROXIES=*` (yes, with an asterisk) when you have a reverse proxy like nginx or Traefik\n\n\n\n\n> [!NOTE]\n> Change the password FIRST. If you change the password *after* you started Docker, it will complain about having no access.\n\n\n\n\n### Run the compose file {#run-the-compose-file}\n\n\nRun the following command in the directory where all files are present.\n\n```text\ndocker compose -f docker-compose.yml up -d --pull=always\n```\n\nYou can follow the progress of the installation by running this command:\n\n```text\ndocker compose -f docker-compose.yml logs -f\n```\n\nWhen the installation is done, Firefly III will thank you for installing it. Once you see this message, you can visit Firefly III. It will be running at [http://localhost](http://localhost).\n\n\n### Set up Firefly III {#set-up-firefly-iii}\n\n\nFollow these how-to's and tutorials to set up Firefly III:\n\n- [Tutorial: Create accounts and transactions](/tutorials/finances/first-steps/)\n- [Tutorial: My first accounts](/tutorials/finances/first-accounts/)\n- [How-to: organize transactions](/how-to/firefly-iii/finances/transactions/)\n\n\n### Create an access token {#create-an-access-token}\n\n\nFollow [how-to get a token](/how-to/firefly-iii/features/api/). Use the custom instructions below:\n\n1. The callback URL will be `http://localhost:81/callback`\n2. UNCHECK the box that says \"Confidential\"\n\n\n### Browse to the data importer {#browse-to-the-data-importer}\n\n\nNow, browse to the Data Importer. It will be running at [http://localhost:81/](http://localhost:81/).\n\nEnter the Client ID from the previous step. In my example, it is \"3\":\n\n![Enter the client ID](/_media/5501d5379d99feef356b.png)\n\nPress the button to Authenticate. You should give permission on the next screen. Note how the name of your client is reflected in the question:\n\n![Give permission](/_media/85438c8aa92de1ad91fa.png)\n\nYou should get back on the Data Importer index:\n\n![Ready to go!](/_media/95ab0fb8a496e9343918.png)\n\nYou are now ready to go!\n\n- [Tutorial: Import from a third party data provider](/tutorials/data-importer/data-providers/)\n- [How-to: import a data file](/how-to/data-importer/import/file/)\n\n\n## Plain Docker {#plain-docker}\n\n\nYou can also use Docker itself, skipping Docker Compose. This allows you to set up a single container, with just the data importer inside of it.\n\nTo run the Data Importer as a singular container using the following `run` command. You will start a web server on port 8081 that will allow you to use the data importer.\n\nFollow [how-to get a token](/how-to/firefly-iii/features/api/). Use the custom instructions below:\n\n1. The callback URL will be your Firefly III installation\n2. UNCHECK the box that says \"Confidential\"\n\nNote that most people don't use GoCardless *and* Spectre values at the same time.\n\nAll environment variables are optional, but convenient. Please note that the `NORDIGEN` environment variables refer to GoCardless.\n\n```bash\ndocker run \\\n-e FIREFLY_III_ACCESS_TOKEN=(here) \\\n-e FIREFLY_III_URL=(here) \\\n-e NORDIGEN_ID=(here) \\\n-e NORDIGEN_KEY=(here) \\\n-e SPECTRE_APP_ID=(here) \\\n-e SPECTRE_SECRET=(here) \\\n-p 8081:8080 \\\nfireflyiii/data-importer:latest\n\n```\n\n\n\n> [!NOTE]\n> **Run in the background**\n>\n> Change `docker run` to `docker run -d` so the image runs in the background.\n\n\n\nIf you have questions, please refer to [the Docker FAQ](/references/faq/docker/) or contact me using the instructions from the [support page](/explanation/support/).\n",
      "documentId": "how-to/data-importer/installation/docker",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/docker/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/docker/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/installation/portainer/index.md",
      "kind": "page",
      "title": "Installation using Portainer",
      "description": "Portainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/portainer/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/portainer/index.md",
      "file": "how-to/data-importer/installation/portainer/index.md",
      "searchText": "\n# Installation using Portainer {#installation-using-portainer}\n\n\nPortainer is a well known container management tool for Docker. It can help you manage your containers, networks and volumes.\n\nThese instructions are for the CE edition.\n\nYou can add Firefly III and the Data Importer as a \"stack\" using the instructions below.\n\n\n## Preparation {#preparation}\n\n\nYou will need to download and save the following configuration files:\n\n1. [Docker compose](https://raw.githubusercontent.com/firefly-iii/docker/main/docker-compose-importer.yml) file\n2. This [stack.env](https://support.firefly-iii.org/composed.php) file with all the environment variables. Save it as `stack.env`.\n\n\n### Edit docker compose file {#edit-docker-compose-file}\n\n\nOpen the docker compose file in your favorite editor, and change all references under `env_file:` to say `env_file: stack.env`.\n\n\n\n> [!TIP]\n> All `env_file:` references must be pointing to exactly `stack.env`. Nothing else.\n\n\n\n\n### Edit stack.env {#edit-stackenv}\n\n\nYou must do a few things:\n\n1. Change `DB_PASSWORD` in `stack.env` to something else. Pick a nice password.\n2. Also change `MYSQL_PASSWORD` in `stack.env` to the SAME value (it's at the bottom)\n3. Change `FIREFLY_III_URL` in `stack.env` to `http://app:8080`\n4. Change `VANITY_URL` in `stack.env` to `http://localhost`\n5. Set `TRUSTED_PROXIES=*` (yes, with an asterisk) when you have a reverse proxy like nginx or Traefik\n\n\n## Installation {#installation}\n\n\n\n### Add docker compose file {#add-docker-compose-file}\n\n\nOpen Portainer and go to the environment where you want to install Firefly III. This is usually the \"local\" one. Then, select \"Stacks\" in the left-hand menu. Click \"Add stack\".\n\nGive your stack the name `firefly-iii`, and copy-paste the content of your edited docker compose file.\n\n![Creating a stack](/_media/c6abd0e4b50412ee38a3.png)\n\n\n### Add stack.env file {#add-stackenv-file}\n\n\nUpload the `stack.env` file here. You will see that Portainer will expand all the environment variables in the file.\n\n![Loading environment variables](/_media/b8551edd4eeeb945b35c.png)\n\nIf you did not make the changes indicated earlier, now is the time.\n\n![Editing environment variables](/_media/4306e902b1af42b3c274.png)\n\n\n## Deploy! {#deploy}\n\n\nPress the button to get the stack deployed! After a while, it should run as expected.\n\n![Portainer stack](/_media/1b2a95660c2ed196c222.png)\n\n![Portainer final overview](/_media/cf4e79a8916d6359775b.png)\n\nThe default configuration will run Firefly III on port 80 which means you can visit Firefly III at [http://localhost](http://localhost). If your portainer is running somewhere else, or in a different configuration, the URL will be different of course. \n\nThe data importer (again, in the default configuration) can be reached at [http://localhost:81](http://localhost:81).\n\nFrom this point forward, you can follow these tutorials and guides to help you set up:\n\n- [Tutorial: Create accounts and transactions](/tutorials/finances/first-steps/)\n- [Tutorial: My first accounts](/tutorials/finances/first-accounts/)\n- [Tutorial: Import a basic CSV file](/tutorials/data-importer/csv/)\n\n",
      "documentId": "how-to/data-importer/installation/portainer",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/portainer/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/portainer/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/installation/kubernetes/index.md",
      "kind": "page",
      "title": "Using Kubernetes",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/kubernetes/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/kubernetes/index.md",
      "file": "how-to/data-importer/installation/kubernetes/index.md",
      "searchText": "\n# Using Kubernetes {#using-kubernetes}\n\n\nIn the [GitHub repository](https://github.com/firefly-iii/kubernetes) 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.\n\nYou can find more [instructions on GitHub](https://firefly-iii.github.io/kubernetes/).\n\n\n\n> [!NOTE]\n> These instructions aren't very long, and I'm sorry about that. Most stuff is documented on the GitHub page and I just don't know very much about Kubernetes myself. If you feel you can expand this page, please press the edit button next to the title\n\n\n",
      "documentId": "how-to/data-importer/installation/kubernetes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/kubernetes/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/kubernetes/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/installation/self-managed/index.md",
      "kind": "page",
      "title": "Self-managed server",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/self-managed/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/self-managed/index.md",
      "file": "how-to/data-importer/installation/self-managed/index.md",
      "searchText": "\n# Self-managed server {#self-managed-server}\n\n\nIf 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.\n\nPlease [install Firefly III first](/how-to/firefly-iii/installation/self-managed/).\n\n\n## Ingredients {#ingredients}\n\n\nThese PHP packages should already be installed, because you installed Firefly III. Nevertheless, here they are:\n\n* PHP BCMath Arbitrary Precision Mathematics\n* PHP JSON\n\nYou can search the web to find out how to install these modules. Some may be installed already depending on your system. Use `phpinfo()` or `php -i` to find out.\n\n\n## Installing the Data Importer {#installing-the-data-importer}\n\n\n\n\n> [!WARNING]\n> **Installing by pulling the remote repository**\n>\n> It's no longer possible to install the data importer by pulling the code from the `main` or `develop` branch of the repository. Generated (JS) code and other dependencies are not in the repository, so your new installation may not work as expected.To do so manually, please [review this FAQ question](/references/faq/install/#i-want-to-build-the-data-importer-release-myself)\n\n\n\n\n### Main command {#main-command}\n\n\n%IMPORTERVERSION is the [latest version](https://version.firefly-iii.org/).\n\n- [Download the latest release as a `zip` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.zip) from GitHub.\n- [Download the latest release as a `tar.gz` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.tar.gz) from GitHub.\n\nIt is up to you, if you prefer the `tar.gz` file or the `zip` file.\n\n\n### Validate the downloaded file {#validate-the-downloaded-file}\n\n\nOptionally, you can validate and test the integrity of your download by also downloading the SHA256 checksum file.\n\n- [SHA256 checksum file of the `zip` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.zip.sha256).\n- [SHA256 checksum file of the `tar.gz` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.tar.gz.sha256).\n\nWith this SHA256 checksum file, you can verify the integrity of the download by running the following command:\n\n```bash\n# Should return: \"DataImporter-%IMPORTERVERSION.zip: OK\"\nsha256sum -c DataImporter-%IMPORTERVERSION.zip.sha256\nsha256sum -c DataImporter-%IMPORTERVERSION.tar.gz.sha256\n\n# alternative command:\nshasum -a 256 -c DataImporter-%IMPORTERVERSION.zip.sha256\nshasum -a 256 -c DataImporter-%IMPORTERVERSION.tar.gz.sha256\n```\n\n### Extract the file {#extract-the-file}\n\n\nExtract the downloaded file in your web server's root directory, or in a specific directory you want to use.\n\n```bash\n# the directory name is up to you, of course:\nmkdir /var/www/data-importer\nunzip DataImporter-%IMPORTERVERSION.zip -d /var/www/data-importer\n\n# the tar.gz file extracts with the following command.\ntar -xvf DataImporter-%IMPORTERVERSION.tar.gz -C /var/www/data-importer\n```\n\nSome servers require `sudo` to extract or change things in the `/var/www` directory. if this is the case for you, make sure you reset the access rights after wards:\n\n```bash\n# the directory name is up to you, of course:\nsudo -u www-data mkdir /var/www/data-importer\nsudo -u www-data unzip DataImporter-%IMPORTERVERSION.zip -d /var/www/data-importer\n\n# alternative command for the tar.gz file:\nsudo tar -xvf DataImporter-%IMPORTERVERSION.tar.gz -C /var/www/data-importer\n\nsudo chown -R www-data:www-data /var/www/data-importer\nsudo chmod -R 775 /var/www/data-importer/storage\n```\n\nThis should get you the entire installation in the directory of your choice.\n\n\n### Web server configuration {#web-server-configuration}\n\n\nMost servers will serve files from the `/var/www` directory. The data importer would be served from `/data-importer/public`. This is not really what you would want to do.\n\nYou can look up for your webserver (Apache or nginx) how to change the root directory or how to set up virtual hosts.\n\n\n### Data Importer configuration {#data-importer-configuration}\n\n\nIn the directory where you just unzipped the data importer you will find a `.env.example` file. Rename or copy it to `.env`.\n\n```bash\ncp .env.example .env\n```\n\nOpen this file using your favorite editor. There are instructions what to do in this file.\n\nMake your life easier by configuring the `FIREFLY_III_URL` and possibly the `FIREFLY_III_ACCESS_TOKEN` variable.\n\nTo run the data importer behind a reverse proxy, set the `TRUSTED_PROXIES` environment variable to either `*` or the IP address of your reverse proxy.\n\nNow you should be able to visit [http://localhost/data-importer/public](http://localhost/data-importer/public) and see the Firefly III data importer.\n\n\n### It doesn't work! {#it-doesnt-work}\n\n\nThis manual can't list all the possible exceptions and errors you may run into. Some common issues are documented [in the FAQ](/references/faq/install/).\n\nLook in these directions when you're running into problems:\n\n* Apache may not have mod_rewrite enabled or the htaccess file isn't activated (`AllowOverride`).\n* Nginx may not have the correct `try_files` instruction in the `location` block.\nTo enable TLS in the data importer, your reverse proxy must be configured correctly. Find more information in the [Frequently Asked Questions](/references/faq/install/).\n\n\n\n## Visiting the data importer {#visiting-the-data-importer}\n\n\nCheck out [the tutorial on how to import CSV files](/tutorials/data-importer/csv/).\n\n![Opening screen of the data importer.](/_media/95ab0fb8a496e9343918.png)\n\n\n\n> [!IMPORTANT]\n> **Need help?**\n>\n> If something did not go as expected, please browse to the [Frequently Asked Questions](/references/faq/install/) or the [Support](/explanation/support/) pages.\n\n\n",
      "documentId": "how-to/data-importer/installation/self-managed",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/self-managed/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/installation/self-managed/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/how-to-configure/index.md",
      "kind": "page",
      "title": "How to configure the data importer",
      "description": "The Data Importer communicates with Firefly III over the API.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/how-to-configure/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/how-to-configure/index.md",
      "file": "how-to/data-importer/how-to-configure/index.md",
      "searchText": "\n# How to configure the data importer {#how-to-configure-the-data-importer}\n\n\nThe Data Importer communicates with Firefly III over the [API](/references/firefly-iii/api/). \n\nOn this page you will read how to:\n\n1. Configure access to the Firefly III API.\n2. Configure third party data providers (optional)\n\nPlease also refer to the following guides.\n\n- [How to install the data importer using Docker](/how-to/data-importer/installation/docker/)\n- [How to install the data importer on your own server](/how-to/data-importer/installation/self-managed/)\n- [General introduction to the data importer](/explanation/data-importer/introduction/)\n- [What are third party data providers?](/tutorials/data-importer/data-providers/)\n- [How to get a personal access token](/how-to/firefly-iii/features/api/)\n\n\n## Access to Firefly III {#access-to-firefly-iii}\n\n\nFirst, you must tell the data importer where to reach Firefly III.\n\nFirefly III can be reached over two URLs at the same time. In most cases this URL is always the same. For Docker installations, these URLs are often different.\n\nThe `FIREFLY_III_URL` is the URL that the data importer uses to reach Firefly III. The `VANITY_URL` is the URL that you use to reach Firefly III.\n\nIn case of Docker installations, the `FIREFLY_III_URL` is an \"internal\" URL, often in the form you see below, `http://app:8080`. Because you cannot browse to that URL, there is a second variable, the `VANITY_URL`, which is the URL you use to reach Firefly III. Most often, this is `http://localhost`.\n\nIf you are not using Docker, both URLs are the same and you can safely set `FIREFLY_III_URL` only.\n\n| Environment variable | Probable value when Docker | Probable value when not Docker |\n|----------------------|----------------------------|--------------------------------|\n| `FIREFLY_III_URL`    | `http://app:8080`          | `https://localhost`            |\n| `FIREFLY_III_URL`    | `http://172.16.2.2:8080`   | `http://myserver.lan`          |\n| `VANITY_URL`         | `http://localhost`         | `http://localhost`             |\n\nIf you use Docker, remember that the `FIREFLY_III_URL` is a reference to Firefly III from inside the data importer container. Therefore, in most cases, the URL is `http://app:8080`, as you can see in the examples above. This happens because Docker containers can use the container name to refer to each other.\n\nIf you do not use Docker, the `FIREFLY_III_URL` is probably your localhost or the location of your existing Firefly III installation.\n\nThe `VANITY_URL` is rarely used outside of Docker containers. It contains the URL of Firefly III as you see it in your address bar. This is often not the same as the `FIREFLY_III_URL`.\n\nThe `FIREFLY_III_URL` is optional. If you don't set it, the data importer will ask for the URL. If you do not set it, the `VANITY_URL` will be ignored.\n\n\n\n> [!WARNING]\n> **Docker and 127.0.0.1**\n>\n> Docker cannot connect to a Firefly III installation using `http://localhost` or `http://127.0.0.1` because this address refers to the Docker container itself, and not Firefly III.\n\n\n\n\n## Authenticate to Firefly III {#authenticate-to-firefly-iii}\n\n\nSecond, to authenticate with Firefly III you must set ONE of the following variables:\n\n1. Set a [Personal Access Token](/how-to/firefly-iii/features/api/) in the `FIREFLY_III_ACCESS_TOKEN` environment variable.\n2. OR set a [Client ID](/how-to/firefly-iii/features/api/) in the `FIREFLY_III_CLIENT_ID` environment variable.\n\nYou can get these variables by reading [how to talk to the API](/how-to/firefly-iii/features/api/).\n\n\n\n> [!NOTE]\n> **Authelia and other tools**\n>\n> Firefly III combined with [external identity providers](/how-to/firefly-iii/advanced/authentication/) such as Authelia can only handle Personal Access Tokens.\n\n\n\nThese variables are mutually exclusive. If you set both, the data importer will use the Personal Access Token. If you set neither, the data importer will ask for the client ID.\n\n\n## Configure third party data providers (optional) {#configure-third-party-data-providers-optional}\n\n\nThe following steps are also listed on the [page about data providers under the tutorials section](/tutorials/data-importer/data-providers/), but here are just the connection instructions for each provider the data provider supports. And also, the instructions for data importers not yet supported. Sorry about that, I am working hard to get them integrated into the data importer!\n\n\n### basiq.io {#basiqio}\n\n\nNot yet supported. Stay tuned!\n\n\n### Enable Banking {#enable-banking}\n\n\nNot yet supported. Stay tuned!\n\n\n### FinTS {#fints}\n\n\nNot yet supported. Stay tuned!\n\n\n### GoCardless {#gocardless}\n\n\nThis is necessary if you wish to connect to your bank through GoCardless.\n\n* `NORDIGEN_ID` is your GoCardless Client ID\n* `NORDIGEN_KEY` is your GoCardless Client Secret\n* If you set `NORDIGEN_SANDBOX` to `true` the data importer will only connect to the GoCardless sandbox.\n\nIf you do not set these, the data importer will ask for them.\n\n\n### Lunch Flow {#lunch-flow}\n\n\nThis is necessary to set if you want to connect to Lunch Flow:\n\nSet the following environment variable. It depends a little bit on how you run the data importer how you must do this. You may have to edit `.importer.env` or set it in your Docker configuration.\n\n```\nLUNCH_FLOW_API_KEY=your_api_key_here\n```\n\n\n### Open Banking/HBCI {#open-bankinghbci}\n\n\nNot yet supported. Stay tuned!\n\n\n### SimpleFIN {#simplefin}\n\n\nThe SimpleFIN connection can be set up through the UI, but you can also set the following environment variable:\n\n- `SIMPLEFIN_TOKEN` is your SimpleFIN connection token.\n\n\n### teller.io {#tellerio}\n\n\nNot yet supported. Stay tuned!\n\n\n### Configure Spectre {#configure-spectre}\n\n\n\n\n> [!WARNING]\n> As of October 31st, 2025 Salt Edge no longer offers free-tier access for Firefly III users. To prevent disappointment, the instructions for Salt Edge have been removed and in due time, Salt Edge support will be removed from the data importer.\n\n\n\n\n## Where to set the configuration? {#where-to-set-the-configuration}\n\n\nAll the configuration values mentioned on this page are stored in environment variables. For example:\n\n* `FIREFLY_III_URL`\n* `FIREFLY_III_ACCESS_TOKEN`\n* `FIREFLY_III_CLIENT_ID`\n\nYou can use the `.env` file to store them, use Docker's `-e` flag to set them or use your operating system to set these values. This depends on your installation method, [Docker](/how-to/data-importer/installation/docker/) or [self-managed](/how-to/data-importer/installation/self-managed/).\n\n\n\n> [!TIP]\n> **Cookie warning**\n>\n> You may need to clear your cookies, browse to `/flush` or press \\[Reauthenticate\\] after changing these values.\n\n\n",
      "documentId": "how-to/data-importer/how-to-configure",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/how-to-configure/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/how-to-configure/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/upgrade/docker/index.md",
      "kind": "page",
      "title": "Upgrade using Docker",
      "description": "This page gives you instructions on how to upgrade your Data Importer installation.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/docker/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/docker/index.md",
      "file": "how-to/data-importer/upgrade/docker/index.md",
      "searchText": "\n# Upgrade using Docker {#upgrade-using-docker}\n\n\nThis page gives you instructions on how to upgrade your Data Importer installation.\n\n\n## Upgrade Docker compose {#upgrade-docker-compose}\n\n\nThe default installation refers to Docker Compose. To upgrade, do this in the directory where you stored all the Docker Compose and environment files.\n\n```bash\ndocker compose stop\ndocker compose rm -f\ndocker compose pull\ndocker compose -f docker-compose.yml up -d --remove-orphans\n```\n\n\n## Upgrade Docker {#upgrade-docker}\n\n\nTo upgrade a single container, stop and remove your container using these commands:\n\n```bash\ndocker stop [container-id]\ndocker rm [container-id]\n```\n\nTo find out which container is the Firefly III Data Importer, run `docker container ls -a` and look for `fireflyiii/data-importer`.\n\nThen pull the new image using this command:\n\n```bash\ndocker pull fireflyiii/data-importer:latest\n```\n\nCreate it again by running the commands from [the installation how-to guide](/how-to/data-importer/installation/docker/).\n",
      "documentId": "how-to/data-importer/upgrade/docker",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/docker/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/docker/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/upgrade/kubernetes/index.md",
      "kind": "page",
      "title": "Using Kubernetes",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/kubernetes/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/kubernetes/index.md",
      "file": "how-to/data-importer/upgrade/kubernetes/index.md",
      "searchText": "\n# Using Kubernetes {#using-kubernetes}\n\n\nIn the [GitHub repository](https://github.com/firefly-iii/kubernetes) 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.\n\nYou can find more [instructions on GitHub](https://firefly-iii.github.io/kubernetes/) on how to upgrade.\n\n\n\n> [!NOTE]\n> These instructions aren't very long, and I'm sorry about that. Most stuff is documented on the GitHub page and I just don't know very much about Kubernetes myself. If you feel you can expand this page, please press the edit button next to the title\n\n\n",
      "documentId": "how-to/data-importer/upgrade/kubernetes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/kubernetes/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/kubernetes/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/upgrade/self-managed/index.md",
      "kind": "page",
      "title": "Upgrade a self-managed server",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/self-managed/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/self-managed/index.md",
      "file": "how-to/data-importer/upgrade/self-managed/index.md",
      "searchText": "\n# Upgrade a self-managed server {#upgrade-a-self-managed-server}\n\n\n\n## Created using composer \"create-project\" {#created-using-composer-create-project}\n\n\nThe 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.\n\n\n## Straight from GitHub {#straight-from-github}\n\n\n\n\n> [!WARNING]\n> **Upgrading by pulling the remote repository**\n>\n> It's no longer possible to upgrade the data importer by pulling the code from the `main` or `develop` branch of the repository. Generated (JS) code and other dependencies are not in the repository, so your upgraded installation may not work as expected.\n\n\n\n%IMPORTERVERSION is the [latest version](https://version.firefly-iii.org/).\n\n- [Download the latest release as a `zip` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.zip) from GitHub.\n- [Download the latest release as a `tar.gz` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.tar.gz) from GitHub.\n\nIt is up to you, if you prefer the `tar.gz` file or the `zip` file.\n\n\n### Validate the downloaded archive {#validate-the-downloaded-archive}\n\n\nOptionally, you can validate and test the integrity of your download by also downloading the SHA256 checksum file.\n\n- [SHA256 checksum file of the `zip` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.zip.sha256).\n- [SHA256 checksum file of the `tar.gz` file](https://github.com/firefly-iii/data-importer/releases/download/%IMPORTERVERSION/DataImporter-%IMPORTERVERSION.tar.gz.sha256).\n\nWith this SHA256 checksum file, you can verify the integrity of the download by running the following command:\n\n```bash\n# Should return: \"DataImporter-%IMPORTERVERSION.zip: OK\"\nsha256sum -c DataImporter-%IMPORTERVERSION.zip.sha256\nsha256sum -c DataImporter-%IMPORTERVERSION.tar.gz.sha256\n\n# alternative command:\nshasum -a 256 -c DataImporter-%IMPORTERVERSION.zip.sha256\nshasum -a 256 -c DataImporter-%IMPORTERVERSION.tar.gz.sha256\n```\n\n\n### Move the old installation {#move-the-old-installation}\n\n\nMove the old installation to a temporary directory, ie `data-importer-old`. Example commands:\n\n```bash \n# moves the entire installation to a backup directory.\n# this also serves as an impromptu backup of your installation\nmv /var/www/data-importer /var/www/data-importer-old\n```\n\n\n### Extract the archive {#extract-the-archive}\n\n\nExtract the archive with the new release wherever you had installed the Firefly III data importer. In this example, it is `/var/www/data-importer`, but it could be anywhere. To do this over the command line, use the following command:\n\n```bash\n# The destination directory can be changed, of course.\nunzip -o DataImporter-%IMPORTERVERSION.zip -x \"storage/*\" -d /var/www/data-importer\n\n# a tar.gz alternative:\ntar -xvf DataImporter-%IMPORTERVERSION.tar.gz -C /var/www/data-importer --exclude='storage'\n```\n\nUse `sudo` if necessary, but if you do, make sure that you set the ownership of the `/var/www/data-importer` directory to `www-data` again:\n\n```bash\n# The destination directory can be changed, of course.\nsudo chown -R www-data:www-data /var/www/data-importer\nsudo chmod -R 775 /var/www/data-importer/storage\n```\n\n\n### Exclude the storage directory {#exclude-the-storage-directory}\n\n\nWhen unpacking, make sure you do not overwrite the storage directory. That's why the `-x \"storage/*\"` and `--exclude='storage'` part is important. It prevents the default storage directory from being extracted. You will overwrite it anyway from the old installation directory.\n\n\n### Copy over files from the old version {#copy-over-files-from-the-old-version}\n\n\nCopy the `.env` file and the entire `storage` folder from the old installation to the new one. Example commands:\n\n```bash\n# copy the .env file\ncp /var/www/data-importer-old/.env /var/www/data-importer/.env\n\n# copy the storage directory\ncp -r /var/www/data-importer-old/storage /var/www/data-importer\n```\n\n\n### Run upgrade commands {#run-upgrade-commands}\n\n\nRun the following commands to upgrade the database and the application:\n\n```bash\nphp artisan cache:clear\nphp artisan view:clear\n```\n\nAnd you're done!\n",
      "documentId": "how-to/data-importer/upgrade/self-managed",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/self-managed/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/upgrade/self-managed/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/file/index.md",
      "kind": "page",
      "title": "How to import files",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/index.md",
      "file": "how-to/data-importer/import/file/index.md",
      "searchText": "\n# How to import files {#how-to-import-files}\n\n\nA short how-to guide on how to import files using the Data Importer. This guide assumes you have the Data Importer working and running.\n\nThe data importer can import the following file types:\n\n- CSV files\n- CAMT.053 files\n\nOther file types are not yet supported, but I am working on them.\n\n\n\n> [!NOTE]\n> PDF files will never be supported. Sorry about that.\n\n\n\nFollow these steps to import your file. The flow is almost the same for each file type, but exceptions are noted clearly.\n\n\n## Download your files {#download-your-files}\n\n\nUsually, banks call this \"downloading\" or \"exporting\" of your transactions. When possible select a range of transactions (i.e. two weeks) and select your bank accounts.\n\n\n### Do some research {#do-some-research}\n\n\nSpecifically for **CSV** files, make sure you know the following things about your **CSV** file:\n\n- Whether it has headers\n- What the delimiter is\n- What each column contains\n\nYou'll have to compare the column contents with [this reference of all \"roles\"](/references/data-importer/roles/) that a column can have. Pretty basic standards are the date of the transaction or the amount, but there are a few special options.\n\nThis is important, because in a later step during the import you must tell the importer the role of each column in your CSV file.\n\nThis step does not apply to other file types.\n\n\n## Upload and get to the configuration screen {#upload-and-get-to-the-configuration-screen}\n\n\nWhen you upload a file and get to the configuration screen, please validate the configuration with the properties of your file (see above).\n\n\n## Configuration screen {#configuration-screen}\n\n\nMost options are explained on the configuration page itself, but the most important options are below:\n\n\n### Headers {#headers}\n\n\nThis step only applies to CSV files. \n\nWhen you import a CSV file, this checkbox allows you to indicate if your CSV file has headers on the first line of the file instead of data.\n\n![A CSV file with headers](/_media/247d5d038f435fad8fbe.png \"A CSV file with headers\")\n\n\n### Convert to UTF-8 {#convert-to-utf-8}\n\n\nSome files are not delivered as UTF-8, which is a common text encoding format. You can ask the data importer to convert the files. You may end up with garbled text. This may happen especially when you have lines with special characters in them.\n\n\n### CSV delimiter {#csv-delimiter}\n\n\nThis step only applies to CSV files.\n\nWhen you import a CSV file, you must select the field separator of our CSV file. This is almost always a comma.\n\n![A CSV file with comma separation](/_media/cbaf403096242c403227.png \"A CSV file with comma separation\")\n\n\n### Date format {#date-format}\n\n\nThis step only applies to CSV files.\n\nThis option sets the date format of the date entries in the CSV file. If your file contains internationalized dates, you can prefix the date format with your country code, like `it:` or `nl:`. Then, enter your date format.\n\nRead more about the format in the [PHP documentation](https://www.php.net/manual/en/datetime.format.php).\n\nHere are some examples:\n\n* `Ymd`. Will convert `20210318`\n* `F/j/Y`. Will convert `January/17/2021`\n* `nl:d F Y`. Will convert Dutch date `5 mei 2021`\n\n![Date configuration value \"Ymd\" is necessary to parse this file](/_media/356ec9e408befe7f7321.png \"Date configuration value 'Ymd' is necessary to parse this file\")\n\n\n### Set other import options {#set-other-import-options}\n\n\n- **Default import account**: Select the asset account you want to link transactions to, if your import doesn't have enough meta-data to determine this. This is some time useful when files just list the transactions and the destination, nothing more.\n- **Rules**: Select this if you want Firefly III to apply your rules to the import. It is useful to run your rules after the import, so the transactions are cleaned up.\n- **Import tag**: When you check this the data importer will add a tag to each imported transaction denoting the import; this groups your import under a tag.\n- **Date range**: The date options are explained on the page itself, and other options should be fairly clear. There's also a guide on [how to map data](/how-to/data-importer/import/map-data/), if you want to link your CSV data to Firefly III data more easily.\n\n\n\n> [!NOTE]\n> **Rules**\n>\n> If you have rules that remove all tags from a transaction, they will *not* work when you use this option. The tag will always be added. This is not because the data importer uses some magic trick. The tag is added *after* the transaction is created.\n\n\n\n\n### Custom import tag {#custom-import-tag}\n\n\nYou can set a custom import tag if you do not like the default one. To learn more about the possibilities, read the [FAQ on custom import tags](/how-to/data-importer/advanced/custom-import-tag/).\n\n\n### Duplicate detection {#duplicate-detection}\n\n\nAlso think about the duplicate detection method you wish to use. If you're not sure which one you want to use, please check out the [reference guide on duplicate detection](/references/data-importer/duplicate-detection/), and make sure you read [how to handle (missed) duplicates](/how-to/data-importer/import/duplicates/).\n\n\n## Select roles {#select-roles}\n\n\nEarlier you validated what the columns your CSV file contain. Select the correct roles for your data using [the role reference](/references/data-importer/roles/).\n\n\n## Mapping data {#mapping-data}\n\n\nThere is a full [how to on mapping data](/how-to/data-importer/import/map-data/) that you should really check out.\n\n\n## Import the data {#import-the-data}\n\n\nThe import process consists of two steps. First a conversion and data validation. Then, the data will actually be sent to Firefly III.\n\nPress \"Start Job\" to start the conversion and validation process. If this is successful, you can press \"Start Job\" after a few moments to import the data.\n\nEach step can run into plenty of errors. Most of them are documented in [this FAQ](/references/faq/data-importer/import/), but I'm pretty sure I missed a few. Please refer to the [support page](/explanation/support/) if you need help.\n",
      "documentId": "how-to/data-importer/import/file",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/file/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/automated/index.md",
      "kind": "page",
      "title": "How to do automated imports",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/automated/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/automated/index.md",
      "file": "how-to/data-importer/import/automated/index.md",
      "searchText": "\n# How to do automated imports {#how-to-do-automated-imports}\n\n\n\n## Preparation {#preparation}\n\n\nFirst, do this:\n\n1. [How to install the Data Importer](/how-to/data-importer/installation/docker/)\n2. [How to import using the CLI](/how-to/data-importer/advanced/cli/)\n3. [How to import using HTTP POST](/how-to/data-importer/advanced/post/)\n\n\n## Configuration {#configuration}\n\n\nThen, in the `.importer.env`-file:\n\n- Add `IMPORT_DIR_ALLOWLIST=/import`\n- Add a value for `FIREFLY_III_ACCESS_TOKEN`\n- Add `NORDIGEN` or `SPECTRE` credentials (`NORDIGEN` is used for GoCardless).\n- Set `CAN_POST_AUTOIMPORT=true`\n- Set `CAN_POST_FILES=true`\n- Set `AUTO_IMPORT_SECRET` using a random string of at least 16 characters. This is used to secure the auto-import endpoint. Visit [this page on random.org](https://www.random.org/passwords/?num=1&len=16&format=html&rnd=new) for inspiration.\n\n\nAnd in the Docker Compose file from the installer, mount a local directory to `/import` in the container:\n\n```yaml\nvolumes:\n  - ./import:/import\n```\n\n\n## Run the import once {#run-the-import-once}\n\n\nIn 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.\n\n\n## Run another import, automatically {#run-another-import-automatically}\n\n\nRun the following command:\n\n```bash\ndocker exec firefly_iii_importer php artisan importer:import /import/config.json\n```\n\nWhere `firefly_iii_importer` is the container ID, and where `config.json` is the configuration file from the previous step. This should run the import again.\n\n\n## Make it a cron job {#make-it-a-cron-job}\n\n\nTo make this a cron job, run `crontab -e` and add the following line:\n\n```cronexp\n0 22 * * * docker exec firefly_iii_importer php artisan importer:import /import/config.json\n```\n\nThis particular cron job will run on the host system. To make the cron job for the data importer a part of the `docker-compose.yml` file as well, you'll need to do something more complex.\n\n1. Specify the `AUTO_IMPORT_SECRET` in your `.importer.env` file. This value must be at least 16 characters. Visit [this page on random.org](https://www.random.org/passwords/?num=1&len=16&format=html&rnd=new) for inspiration.\n2. In the code below, replace \\[AUTO_IMPORT_SECRET\\] with the same value. \n3. In the code below, replace \\[STATIC_CRON_TOKEN\\] with `STATIC_CRON_TOKEN` value from your `.env` file. \n4. Replace the `firefly_iii_cron`-container entry in your compose file with the resulting code:  \n\n```\n  cron_importer:\n    image: alpine\n    container_name: firefly_iii_cron\n    restart: always\n    command: sh -c \"\n      apk add tzdata\n      && ln -s /usr/share/zoneinfo/${TZ} /etc/localtime\n      && echo \\\"0 3 * * * wget -qO- http://app:8080/api/v1/cron/STATIC_CRON_TOKEN;echo\\\" > /tmp/crontab_tmp \n      && echo -e \\\"40 2 * * * wget -qO - --post-data '' --header 'Accept\":\" application/json' 'http://importer:8080/autoimport?directory=/import&secret=[AUTO_IMPORT_SECRET]'\\\" >> /tmp/crontab_tmp \n      && crontab /tmp/crontab_tmp\n      && rm /tmp/crontab_tmp\n      && crond -f -L /dev/stdout\"\n    networks:\n      - firefly_iii\n\n```\n\nPortainer uses may also use the following lines. This will make Portainer do the replacement automatically. This will not work on other systems.\n\n```\n&& echo \\\"0 3 * * * wget -qO- http://app:8080/api/v1/cron/$STATIC_CRON_TOKEN;echo\\\" > /tmp/crontab_tmp \n&& echo -e \\\"40 2 * * * wget -qO - --post-data '' --header 'Accept\":\" application/json' 'http://importer:8080/autoimport?directory=/import&secret=$AUTO_IMPORT_SECRET'\\\" >> /tmp/crontab_tmp \n```",
      "documentId": "how-to/data-importer/import/automated",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/automated/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/automated/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/json/index.md",
      "kind": "page",
      "title": "How to manage JSON configuration files",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/json/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/json/index.md",
      "file": "how-to/data-importer/import/json/index.md",
      "searchText": "\n# How to manage JSON configuration files {#how-to-manage-json-configuration-files}\n\n\nThe 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.\n\nThere is an extensive reference on the exact content of [the JSON configuration file](/references/data-importer/json/).\n\n\n## The first import {#the-first-import}\n\n\nImport some data. Use the other how-to guides or the tutorials to learn how to do this. During the conversion step, you will see this button:\n\n![Download configuration file](/_media/9c607357fcee2f3d3721.png)\n\nWhen you press \"Download configuration file\", a JSON file is downloaded to your computer. Save that file somewhere safe. You can use it to run the import again.\n\n\n## The second import {#the-second-import}\n\n\nYou may have noticed that the importer has a second upload field:\n\n![Download configuration file](/_media/29e7c3e2f7210e8afd8e.png)\n\nUse this field to add the JSON file to your import. As you can see, the importer will use the configuration from the JSON file instead of asking you to configure the import again.\n\n\n## Pre-setting the configuration file {#pre-setting-the-configuration-file}\n\n\n\nYou can store pre-made configuration files in the data importer. This can be useful if you import regularly.\n\n- Store the files in `storage/configurations`\n- Mount a local directory to the `/var/www/html/storage/configurations` directory in Docker.\n- Change the `JSON_CONFIGURATION_DIR` to any custom directory (mount it if you want to), and place them there.\n\nWith Docker:\n\n```\ndocker run [..] -v /home/user/configurations:/configurations [..] -e JSON_CONFIGURATION_DIR=/configurations\n```\n\nThis will show a dropdown with your JSON files ready to be selected:\n\n![Selecting pre-configured JSON files](/_media/c022c19a6737dd97d5b0.png)\n\n\n## Download existing configuration files from other users {#download-existing-configuration-files-from-other-users}\n\n\nThere's a repository on GitHub with [import configurations](https://github.com/firefly-iii/import-configurations) for common banks and financial institutions.\n \nUse these configuration files to make your own import a lot easier to manage.\n",
      "documentId": "how-to/data-importer/import/json",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/json/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/json/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/map-data/index.md",
      "kind": "page",
      "title": "How to map data",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/map-data/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/map-data/index.md",
      "file": "how-to/data-importer/import/map-data/index.md",
      "searchText": "\n# How to map data {#how-to-map-data}\n\n\nAny 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.\n\nThere are several ways to deal with this. You can use [rules](/how-to/firefly-iii/features/rules/) to clean up the transactions after the import. You can also use [webhooks](/how-to/firefly-iii/features/webhooks/) for more advanced stuff.\n\nBut the data importer allows you to \"map\" data to existing data in Firefly III. You can map account names, currency names, categories and many other fields to values already present in your Firefly III database. This will greatly smooth out the import process.\n\n\n## What is mapping? {#what-is-mapping}\n\n\nMapping is a process where you link account names, category names and other fields in your import to data already present in Firefly III. If you do not map data, the Data Importer will use the data \"as is\". This may lead to messy imports.\n\n\n## When do I map data? {#when-do-i-map-data}\n\n\nWhen you import data, you get the option offered to map data on the Configuration screen.\n\n![Option to map data](/_media/e9633449b8b6196e5920.png)\n\nIf you check that box, you will get an option to map data later in the import process.\n\n\n## How do I map data? {#how-do-i-map-data}\n\n\nHere is a screenshot of an import where many names need to be mapped. I have taken the liberty of censoring some names.\n\n![Option to map data](/_media/17b1ea52676bcf023059.png)\n\nIn the third column you see how the data importer would just import everything as-is. If you don't want that, use the dropdown to select the correct opposing expense, revenue or asset account that the value needs to be linked to instead.\n\n\n\n> [!TIP]\n> **This is my first import, I don't have those accounts yet**\n>\n> You can go to Firefly III (in another tab) and create the accounts you're missing. If you refresh the page, they will be visible and selectable.\n\n\n\nHere's an example where I mapped all weird \"Albert Heijn\"-transactions to a single expense account called \"Albert Heijn\".\n\n![Mapping names to one account.](/_media/7fb37c010e04b016e979.png)\n\n\n## Now what? {#now-what}\n\n\nContinue with the import process. After the import is complete, be sure to download the configuration file. This configuration file contains all your mappings, so you don't have to do those again next time.\n\n\n",
      "documentId": "how-to/data-importer/import/map-data",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/map-data/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/map-data/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/third-party-providers/index.md",
      "kind": "page",
      "title": "How to use third party data providers?",
      "description": "The Firefly III data importer supports several third party data providers to help you import your financial data into Firefly III.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/third-party-providers/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/third-party-providers/index.md",
      "file": "how-to/data-importer/import/third-party-providers/index.md",
      "searchText": "\n# How to use third party data providers? {#how-to-use-third-party-data-providers}\n\n\nThe Firefly III data importer supports several third party data providers to help you import your financial data into Firefly III.\n\nOn this page, you will find instructions on how to register for each data provider, and what the associated costs are, if any.\n\nAfter you have registered, your best bet is to check out the [list of tutorials about data providers](/tutorials/data-importer/data-providers/) and find your data provider to continue the import process.\n\n\n## Enable Banking {#enable-banking}\n\n\n[Enable Banking](https://enablebanking.com/) is a European open banking aggregator that connects to 2500+ banks\nacross 29 European countries using official PSD2 APIs.\n\nEnable Banking offers a **free restricted mode** that allows you to access your own pre-authorized bank accounts\nwithout a paid subscription. This makes it ideal for personal finance management with Firefly III.\n\nTo get started, go to [enablebanking.com](https://enablebanking.com/) and click \"Get Started\" to request an account.\n\n\n## GoCardless {#gocardless}\n\n\n\n\n> [!NOTE]\n> GoCardless is \"shifting away\" from their Bank Account Data products (aka the service you need for this to work). These instructions are only here for users who still have access to their GoCardless account.\n\n\n\nGoCardless API access is paid, and they are a commercial organization. Please read and agree with all the terms the company may present you with. They have their own data usage and privacy policies, which you must read up on.\n\nIn the past, you could sign up for the GoCardless API on [their website](https://bankaccountdata.gocardless.com/signup). \n\nGoCardless supports [many PSD2-compliant banks in the EU and the UK](https://nordigen.com/en/coverage/) if you happen to live in these regions.\n\n\n## Lunch Flow {#lunch-flow}\n\n\n[Lunch Flow](https://www.lunchflow.app/) is a paid provider that can connect to many banks through a bunch of APIs they maintain. You can register on their website.\n\n\n## Open Banking/HBCI {#open-bankinghbci}\n\n\nThis data provider is not yet supported, so there are no instructions yet. Stay tuned!\n\n\n## SimpleFIN {#simplefin}\n\n\nSimpleFIN 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](https://www.simplefin.org/).\n\nYour bank should provide you with the necessary credentials to use SimpleFIN. You can then use these credentials to connect to SimpleFIN and import your financial data into Firefly III.\n\n\n## teller.io {#tellerio}\n\n\nThis data provider is not yet supported, so there are no instructions yet. Stay tuned!\n\n\n## basiq.io {#basiqio}\n\n\nThis data provider is not yet supported, so there are no instructions yet. Stay tuned!\n\n\n## FinTS {#fints}\n\n\nThis data provider is not yet supported, so there are no instructions yet. Stay tuned!\n",
      "documentId": "how-to/data-importer/import/third-party-providers",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/third-party-providers/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/third-party-providers/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/transfers/index.md",
      "kind": "page",
      "title": "How to import transfers between accounts",
      "description": "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 fact that Firefly III doesn't realise the opposing account is an asset account.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/transfers/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/transfers/index.md",
      "file": "how-to/data-importer/import/transfers/index.md",
      "searchText": "\n# How to import transfers between accounts {#how-to-import-transfers-between-accounts}\n\n\nThe 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 fact that Firefly III doesn't realise the opposing account is an asset account.\n\nIf Firefly III knows both accounts are asset accounts, it will create transfers. You must provide the right information and configuration.\n\n\n## Recognizing asset accounts {#recognizing-asset-accounts}\n\n\nFirefly III determines the transaction type based on the *source* and *destination* account. Both must be recognized as asset accounts or liabilities (in some cases). If Firefly III doesn't recognize the accounts, it will create new expense/revenue accounts and create a withdrawal/deposit.\n\n\n\n> [!IMPORTANT]\n> If your files contain very little information on the opposing account (either the source or the destination) this will be difficult to do right.\n\n\n\nUse any of the following strategies to so accounts are properly recognized.\n\n\n### Default account {#default-account}\n\n\nThe default account should be an asset account. If this is correct, and your file contains no information on the source account, you're halfway there.\n\n\n### Map data {#map-data}\n\n\nThe import has a [mapping stage](/how-to/data-importer/import/map-data/) during which you can link accounts. Use column role `Opposing account (x)` and `Asset account (x)`. Select the correct asset accounts during the mapping. If both accounts are recognized or mapped as an asset account, the transaction will become a transfer.\n\n\n#### Asset account names and opposing account names {#asset-account-names-and-opposing-account-names}\n\n\nVery few banks provide meaningful opposing account names for your own bank accounts. But this is a worthwhile field to map, because you can also clean up other names.\n\n\n#### IBAN and account numbers {#iban-and-account-numbers}\n\n\nIf your file contains IBAN's or account numbers, definitely use them to link them to your asset accounts.\n\n\n### Store IBANs and account numbers {#store-ibans-and-account-numbers}\n\n\nWhen you create new asset accounts in Firefly III, always store an IBAN or account number. This will improve the (auto) mapping and link transactions.\n\n\n### Test, test, test {#test-test-test}\n\n\nAlways try one or two transactions first. Keep an eye on the logs and turn on debug mode if necessary (see the search) so you can see why / how Firefly III and the data importer create the accounts they do.\n\n\n\n## Transfers aren't merged {#transfers-arent-merged}\n\n\n\nThe Firefly III Data Importer is capable of merging two transactions (one from A > B, and one from B < A) if they seem to be the same transaction listed twice. For example, when you import two files: one from your checking account and one from your savings account.\n\nBy default, Firefly III will skip saving the second transfer because the first one already exists. The second is recognized as a duplicate because all the fields are the same. This may not always be the case. Examples that will stop this from happening are:\n\n- The second transfer has another internal transaction reference (bunq does this).\n- The second transfer has a different description.\n- In the second transfer, any other meta-data is different (notes, links, etc).\n\nYou'll have to manually edit your file so the transactions are the same.\n\nYou can't do this by applying rules to your transfers. Rules are only executed on transactions that are already stored in Firefly III. If your rule changes a transfer into a duplicate of another transfer, this won't make the system delete it.\n\nYou can however, create custom rules that trigger on any content in the second transfer, and then delete it.\n",
      "documentId": "how-to/data-importer/import/transfers",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/transfers/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/transfers/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/duplicates/index.md",
      "kind": "page",
      "title": "How to handle (missed) duplicates",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/duplicates/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/duplicates/index.md",
      "file": "how-to/data-importer/import/duplicates/index.md",
      "searchText": "\n# How to handle (missed) duplicates {#how-to-handle-missed-duplicates}\n\n\nSometimes 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.\n\nThe Firefly III data importer can recognise two different types of duplicate transactions. By default, it will refuse to import both of these types.\n\n1. Duplicate entries in your files are skipped, unless you explicitly tell the data importer to import them anyway.\n2. Firefly III itself will refuse to import transactions it believes already exist. You can overrule this.\n\n\n## Deleted, but duplicate? {#deleted-but-duplicate}\n\n\nThe Data Importer will also check **deleted** transactions when checking for duplicates. This is on purpose! If your import contains bad transactions or informative message hidden as transactions, they will not be re-imported after you've deleted them. If you're sure you wish to reimport transactions, press the **Purge** button on the last tab of your Profile (under `/profile`).\n\nEven when you **delete** the original transaction, importing it again will result in a duplication error. \n\nIf you want to reimport duplicate transactions after deleting them:\n\n1. Turn off duplicate detection\n2. Use the \"purge\"-button in your profile page to permanently remove deleted transactions\n\n\n## Common causes of false negatives {#common-causes-of-false-negatives}\n\n\nA **false negative** is when you know it's a duplicate, but the Data Importer didn't catch it.\n\n\n### Rounding errors {#rounding-errors}\n\n\nSome imports contain \"floating numbers\", which are numbers that look like this:\n\n- `12.00000001`\n- `6.95999999`\n\nThese numbers may have slight variations. Firefly III will see the difference and create what seems to be a duplicate transaction. The user interface may not show you the trailing digits leading you finding a duplicate transaction.\n\n\n### Different internal or external ID's {#different-internal-or-external-ids}\n\n\nYou may find your transaction has a field called `external_id` or `internal_reference`. These fields will sometimes be different. Spectre is known to change these sometimes for no good reason. Nordigen may give pending transactions a different ID from booked transactions.\n\n\n### Transfers are imported twice {#transfers-are-imported-twice}\n\n\nLearn [how to import transfers between accounts](/how-to/data-importer/import/transfers/).\n\n\n### Transfers aren't imported as transfers {#transfers-arent-imported-as-transfers}\n\n\nLearn [how to import transfers between accounts](/how-to/data-importer/import/transfers/).\n\n\n## Common causes of false positives {#common-causes-of-false-positives}\n\n\nA **false positive** happens when you know it's not a duplicate, but the Data Importer believes it is.\n\nThis happens mostly when your data source has too little information to go on. For example, a CSV file with only a very few columns. This has very few other solutions.\n\n\n## Further debugging {#further-debugging}\n\n\nWhen you are not sure why a duplicate is happening, or when you suspect a bug, please follow these three debugging steps first. I know I'm asking a lot, but in many cases the cause can be found easily enough.\n\n\n### First debug step {#first-debug-step}\n\n\nUse the *debug view* to see why a transaction is imported, despite being a duplicate of another transaction. Remember that rules don't influence the (de)duplication process, because rules are applied *after* the duplication check.\n\nOpen both transactions in different tabs of your browser. Notice how the URL is something like this:\n\n* [https://demo.firefly-iii.org/transactions/show/123](https://demo.firefly-iii.org/transactions/show/123)\n\nChange the word `show` in the URL to `debug`:\n\n* [https://demo.firefly-iii.org/transactions/**debug**/123](https://demo.firefly-iii.org/transactions/debug/123)\n\nIf you do this for **both** transactions you will end up with a specific JSON variant of the transaction.\n\nSend it to me or [compare it yourself](https://jsoncompare.org/) to see the differences between two seemingly equal transactions.\n\n- The `created_at` and `updated_at` fields are not used in the comparison by Firefly III.\n- The `import_hash_v2` and `original_source` are not used in the comparison by Firefly III.\n- The `id` and `transaction_journal_id` fields are not used in the comparison by Firefly III.\n\n\n### Second debug step {#second-debug-step}\n\n\nMore debug information may be found in the debug logs of the data importer. At the end of the import and conversion routines, the data importer submits the transactions to Firefly III.\n\nHere is an example of what the data importer submits to Firefly III. Warning: it's a lot!\n\n```\nlocal.DEBUG: Submitting to Firefly III: {\"group_title\":null,\"error_if_duplicate_hash\":true,\"transactions\":[{\"type\":\"withdrawal\",\"date\":\"2017-01-01 00:00:00\",\"currency_id\":1,\"currency_code\":null,\"amount\":\"12.340000000000\",\"description\":\"Some test transaction 2\",\"source_id\":1,\"source_name\":null,\"destination_id\":null,\"destination_name\":\"IsNew1123x\",\"original_source\":\"jc5-data-import-v1.4.3\",\"tags\":[],\"source_iban\":null,\"source_number\":null,\"source_bic\":null,\"destination_iban\":null,\"destination_number\":null,\"destination_bic\":null}]}\n```\n\nWhat you see here is the raw JSON that is submitted. If you look closely, you can see the amount, a description, some metadata and more interesting stuff.\n\nIf you compare two of these, you may not see a difference, but online compare tools like [this one](https://jsoncompare.org/) can help you find the differences. \n\nSome differences aren't entirely visible to the naked eye. For example, if you have a category \"Groceries\" with ID #1, submitting \"Groceries\" or \"1\" will result in the same category. But Firefly III will see this as a difference. This is a silly example as the data importer is consistent about these kinds of things, but it may happen when banks switch from account names to IBANs, for example.\n\n\n### Third debug step {#third-debug-step}\n\n\nIf you want to dive even deeper into why a transaction is (not) a duplicate, even though it should (not) be, you can see what the data importer has downloaded from GoCardless or Spectre. This particular step is not possible for users who import CSV or CAMT files.\n\nThe data importer connects to GoCardless/Spectre, and will at some point start downloading JSON transactions. Here's a snippet from a GoCardless transaction. Again, these are pretty large blobs of JSON, be warned!\n\n```\nproduction.DEBUG: Parsed Nordigen transaction \"ID HERE\". {\"type\":\"withdrawal\",\"date\":\"2024-02-02T01:47:33+00:00\",\"datetime\":\"2024-02-02T01:47:33+00:00\",\"amount\":\"6.500000000000\",\"description\":\"Long description here\",\"payment_date\":\"2024-02-01\",\"order\":0,\"currency_code\":\"EUR\",\"tags\":[\"booked\"],\"category_name\":null,\"category_id\":null,\"notes\":\"\",\"external_id\":\"ID HERE\",\"internal_reference\":\"\",\"additional-information\":\"\",\"source_id\":2,\"destination_name\":\"Destination name here\",\"destination_number\":\"\"}\n```\n\nHere too, you may recognize familiar fields such as the amount and the destination of the transaction.\n\nIf you compare two of these, you may not see a difference, but online compare tools like [this one](https://jsoncompare.org/) can help you find the differences. In these cases, it's not always easy to see if a difference is present, so make sure you also check out the previous debug step to see if the data importer is doing strange data conversions.\n\n\n## Other issues? {#other-issues}\n\n\nPlease open an issue [on GitHub](https://github.com/firefly-iii/firefly-iii/).\n\n\n\n> [!IMPORTANT]\n> At this point the duplication detection process is pretty much 100% correct all the time. If you still believe it's broken, please provide a reproducible example.\n\n\n",
      "documentId": "how-to/data-importer/import/duplicates",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/duplicates/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/duplicates/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/gocardless/index.md",
      "kind": "page",
      "title": "How to use GoCardless",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/gocardless/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/gocardless/index.md",
      "file": "how-to/data-importer/import/gocardless/index.md",
      "searchText": "\n# How to use GoCardless {#how-to-use-gocardless}\n\n\n\n## Introduction {#introduction}\n\n\n\n\n> [!WARNING]\n> GoCardless is sunsetting this free service and registration is unfortunately closed. There is nothing I can do about this.\n\n\n\nThe 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.\n\nPlease read and agree with all the terms the company may present you with. They have their own data usage and privacy policies, which you must read up on.\n\n\n\n> [!IMPORTANT]\n> **Disclaimer**\n>\n> As a general disclaimer: GoCardless is a commercial organisation. They may revoke your access or charge money at any moment. I'm grateful for the free access they provide to Firefly III users.\n\n\n\n\n\n> [!IMPORTANT]\n> **About bank availability**\n>\n> GoCardless supports very few 🇺🇸 American and Asian banks. There is little I can do about this. You'll have to import CSV files.\n\n\n\n\n## GoCardless Bank Account Data API {#gocardless-bank-account-data-api}\n\n\nYou can sign up for the GoCardless API on [their website](https://bankaccountdata.gocardless.com/signup). Access to the GoCardless Bank Account Data API is free for both commercial and personal use (that's you). You will not have to request extended access, but you can get the premium access for a fee if you so wish. Keep in mind that the Firefly III Data Importer currently does not support the premium APIs.\n\n\n\n> [!NOTE]\n> How to sign up for GoCardless:\n>\n>  1. Go to [nordigen.com](https://nordigen.com/en/) or follow the [direct link](https://bankaccountdata.gocardless.com/signup) to the signup form.\n>  2. Press Login\n>  3. Press \"Looking for Bank Account Data (Formerly Nordigen)?\"\n>  4. Click Sign Up\n>  5. Follow the instructions\n>  6. Profit!\n\n\n\nGoCardless supports [many PSD2-compliant banks in the EU and the UK](https://nordigen.com/en/coverage/) if you happen to live in these regions.\n\nAccess to the GoCardless API is limited to raw data only, which means you may have to do data cleanup yourself. You can use Firefly III [rules](/how-to/firefly-iii/features/rules/) or build something yourself.\n",
      "documentId": "how-to/data-importer/import/gocardless",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/gocardless/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/gocardless/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/salt-edge/index.md",
      "kind": "page",
      "title": "How to use Spectre Salt Edge",
      "description": "How to use Spectre Salt Edge",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/salt-edge/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/salt-edge/index.md",
      "file": "how-to/data-importer/import/salt-edge/index.md",
      "searchText": "\n# How to use Spectre Salt Edge {#how-to-use-spectre-salt-edge}\n\n\n\n\n> [!WARNING]\n> As of October 31st, 2025 Salt Edge no longer offers free-tier access for Firefly III users. To prevent disappointment, the instructions for Salt Edge have been removed and in due time, Salt Edge support will be removed from the data importer.\n\n\n",
      "documentId": "how-to/data-importer/import/salt-edge",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/salt-edge/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/salt-edge/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/import/simplefin/index.md",
      "kind": "page",
      "title": "How to use SimpleFIN",
      "description": "To read more, please check out this tutorial.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/simplefin/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/simplefin/index.md",
      "file": "how-to/data-importer/import/simplefin/index.md",
      "searchText": "\n# How to use SimpleFIN {#how-to-use-simplefin}\n\n\n\n## Introduction {#introduction}\n\n\n\n\n## Getting started {#getting-started}\n\n\n\n\n## How to import data {#how-to-import-data}\n\n\nTo read more, please check out **[this tutorial](/tutorials/data-importer/simplefin/)**.\n",
      "documentId": "how-to/data-importer/import/simplefin",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/simplefin/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/import/simplefin/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/advanced/cli/index.md",
      "kind": "page",
      "title": "How to import using the CLI",
      "description": "The Data Importer can import from the command line. Either by calling the Docker container, or by using your self-managed instance.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/cli/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/cli/index.md",
      "file": "how-to/data-importer/advanced/cli/index.md",
      "searchText": "\n# How to import using the CLI {#how-to-import-using-the-cli}\n\n\n\n## Introduction {#introduction}\n\n\nThe Data Importer can import from the command line. Either by calling [the Docker container](/how-to/data-importer/installation/docker/), or by using your [self-managed instance](/how-to/data-importer/installation/self-managed/).\n\nIf you use the data importer just to import data (and the web interface is unused), please read the considerations below.\n\n\n### Configuration {#configuration}\n\n\nThe following environment variable need to be set. This value must match the local directory. If you're using Docker, set it to `/import`.\n\n```\nIMPORT_DIR_ALLOWLIST=/your/directory\n```\n\n\n\n> [!NOTE]\n> **Command line and Docker**\n>\n> When you're using Docker validate that you've mounted a directory with your files in it. This is something you must have done when you launched the Docker container, using for example `-v /path/to/my/files:/import`.\n\n\n\n\n### Importing CSV, camt.053 files and JSON files {#importing-csv-camt053-files-and-json-files}\n\n\nImporting CSV or camt.053 data requires two separate files: the actual content (CSV or XML) and a JSON configuration file. You have get this configuration file *first*, by doing a single import through the UI. Once you have the JSON configuration file you can use it to import any file from your bank, assuming the structure of the file is the same.\n\n\n### Importing from GoCardless {#importing-from-gocardless}\n\n\nIf you import from GoCardless, you just need the JSON configuration file from the data importer. This can be a little confusing because GoCardless also offers JSON downloads of your raw transactions. All you need to import is the JSON file from the data importer itself. This will contain enough information to download everything from GoCardless.\n\n\n## Commands {#commands}\n\n\n\n### Import a single (CSV or camt.053) file {#import-a-single-csv-or-camt053-file}\n\n\nUse the following command to import a single file.\n\nRemember that the JSON file is a reference to the data importer configuration file.\n\n```bash\n# self managed (file)\nphp artisan importer:import file.json file.xml\n\n# self hosted (other sources)\nphp artisan importer:import file.json\n\n# docker (file)\ndocker exec -it [container-id] php artisan importer:import file.json file.csv\n\n# docker (other sources)\ndocker exec -it [container-id] php artisan importer:import file.json\n```\n\nThe JSON file should always point to your JSON configuration file. If you are importing CSV or camt.053 files, replace `file.csv` with the full path to your file.\n\n\n### Import a directory {#import-a-directory}\n\n\nAnother import option is present to import everything in a directory. Here are the necessary commands.\n\n```bash\n# self managed\nphp artisan importer:auto-import /path/to/your/files\n\n# docker\ndocker exec -it [container-id] php artisan importer:auto-import /import\n```\n\n- For each CSV or camt.053 file to import you need two files: `my-file.xml` (or `my-file.csv`) and `my-file.json`.\n- CSV / camt.053 files without a JSON file will be ignored.\n- JSON files without a CSV / camt.053 file will be tried as a GoCardless or Spectre import. Remember that the JSON file is a reference to the data importer configuration file, you do not need to download transactions yourself.\n\n\n## Automatic imports using Docker {#automatic-imports-using-docker}\n\n\nThe following command will run the data importer once. It will try to import whatever it finds in the current directory, and then exit. This is fully automated. It works by mounting the current directory to `/import` and importing all files.\n\n\n\n> [!WARNING]\n> **Different image**\n>\n> Notice how this command uses the `latest-cli` image. This is a different image than the `latest` image. If you start this with the wrong tag, t will start the web server as well, and it will never exit.\n\n\n\n```bash\ndocker run \\\n--rm \\\n-v $PWD:/import \\\n-e FIREFLY_III_ACCESS_TOKEN= \\\n-e IMPORT_DIR_ALLOWLIST=/import \\\n-e FIREFLY_III_URL= \\\n-e WEB_SERVER=false \\\nfireflyiii/data-importer:latest-cli\n```\n\n\n\n> [!IMPORTANT]\n> **Personal Access Token**\n>\n> This little trick only works when you use a [personal access token](/how-to/data-importer/how-to-configure/) (as you can see in the command).\n\n\n\n\n\n> [!IMPORTANT]\n> **GoCardless or Spectre information**\n>\n> If necessary, expand this command with the necessary GoCardless or Spectre keys and ID's.\n\n\n\n\n## Exit codes and troubleshooting {#exit-codes-and-troubleshooting}\n\n\nBy default, the importer also dumps the debug logs in the console. This can be useful to troubleshoot issues. The importer will also return an exit code. This can be used to determine if the import was successful or not automatically. For example, when you monitor the import remotely.\n\n| Exit code | Meaning                                                    |\n|-----------|------------------------------------------------------------|\n| 0         | Successful import                                          |\n| 1         | Generic error or unspecified problem during import         |\n| 64        | Cannot connect to Firefly III                              |\n| 65        | Invalid path provided                                      |\n| 66        | Path is not allowed                                        |\n| 67        | There are no files in the provided directory               |\n| 68        | Cannot read configuration file                             |\n| 69        | Cannot parse configuration file                            |\n| 70        | The importable file cannot be found                        |\n| 71        | The importable file cannot be read                         |\n| 72        | Too many errors processing the data in the importable file |\n| 73        | Nothing was imported during this run                       |\n| 74        | Your GoCardless user agreement has expired                 |\n",
      "documentId": "how-to/data-importer/advanced/cli",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/cli/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/cli/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/advanced/post/index.md",
      "kind": "page",
      "title": "How to import using HTTP POST",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/post/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/post/index.md",
      "file": "how-to/data-importer/advanced/post/index.md",
      "searchText": "\n# How to import using HTTP POST {#how-to-import-using-http-post}\n\n\n\n## Introduction {#introduction}\n\n\nYou 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.\n\n\n\n> [!IMPORTANT]\n> **Personal Access Token required**\n>\n> The POST commands only work when you're using a Personal Access Token to authenticate, set in your `.env`-file or environment variables. You can also add this token to the Authentication header: `Authentication: Bearer [token here]`.\n\n\n\n\n\n> [!IMPORTANT]\n> **GoCardless or Spectre information**\n>\n> You cannot submit GoCardless or Spectre information using the POST commands, the data importer must already be configured with them.\n\n\n\nFor all examples, the following environment variables need to be set:\n\n```\n# the secret is required and must be at least 16 characters long\nAUTO_IMPORT_SECRET=YOURSECRETHERE\n\n# if this value is not set to true, you cannot upload files and import them\nCAN_POST_FILES=true\n\n# if this value is not set to true, you cannot import a local directory\nCAN_POST_AUTOIMPORT=true\n\n# this value must match the local directory\nIMPORT_DIR_ALLOWLIST=/your/directory\n```\n\n\n## Uploading files and importing them {#uploading-files-and-importing-them}\n\n\nAll of these commands require a working Personal Access token (`Authorization: Bearer ey....`). Read more about this in the [API documentation](/how-to/firefly-iii/features/api/) under \"Personal Access Tokens\".\n\n\n### CSV and camt.053 {#csv-and-camt053}\n\n\nYou can upload a file and a JSON file to the data importer to have it imported into your Firefly III installation automatically. To illustrate how this works, here's a CURL request that works.\n\nThe file and the JSON file will both be uploaded, after which the result will be a log of import attempt. Remember that the JSON file is a reference to the data importer configuration file. You do not need to download transactions from GoCardless or other external providers. The `Bearer ` value is static and must not be changed, but `ey....` must be replaced with a Personal Access Token.\n\n```bash\ncurl --location --request POST 'https://data-importer.example.com/autoupload?secret=YOURSECRETHERE' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer ey....' \\\n--form 'importable=@\"/local/path/to/csv.csv\"' \\\n--form 'json=@\"/local/path/to/json.json\"'\n```\n\n\n### GoCardless and Spectre {#gocardless-and-spectre}\n\n\nYou can also import from GoCardless or Spectre, in which case a JSON file is enough. The `Bearer ` value is static and must not be changed, but `ey....` must be replaced with a Personal Access Token.\n\n```bash\ncurl --location --request POST 'https://data-importer.example.com/autoupload?secret=YOURSECRETHERE' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer ey....' \\\n--form 'json=@\"/local/path/to/json.json\"'\n```\n\n\n### Importing a local directory {#importing-a-local-directory}\n\n\nThis POST command allows you to import from a local directory, where you have your files ready to go. For example, you have a directory called `/import` where `bank.csv` and `bank.json` are ready to go. In that case, you could do the following.\n\nRemember that the JSON file is a reference to the data importer configuration file.\n\n```bash\ncurl --location --request POST 'https://data-importer.example.com/autoimport?directory=/import&secret=YOURSECRETHERE'\n```\n\nThe data importer will scroll through everything in the `/import` directory and import whatever is there. In other words, the POST command can trigger the import of files already present somewhere in a place where the data importer can read them.\n\nIn order to set this up, you need the following environment variables:\n\n```\nCAN_POST_AUTOIMPORT=true\nAUTO_IMPORT_SECRET=YOURSECRETHERE\nIMPORT_DIR_ALLOWLIST=/import\n```\n\n1. You must set `CAN_POST_AUTOIMPORT=true` or the command is disabled and will never work.\n2. Without a 16-character secret in `AUTO_IMPORT_SECRET` it will not work either. [Generate one using this page](https://www.random.org/passwords/?num=1&len=16&format=html&rnd=new).\n3. This denotes the directory from which you are allowed to import. Any subdirectory will also be accepted by the POST command. So, you could set this to `/import` and use the POST command to import from `/import/some/other/directory`.\n\nAn optional variable is:\n\n```\nFALLBACK_IN_DIR=false\n```\n\nEach file you import must be accompanied by a JSON file that contains the configuration for the data importer. For example:\n\n```\nbank.csv\nbank.json\nanother_csv_file.csv\nanother_csv_file.json\nsome_xml_file.xml\nsome_xml_file.json\n```\n\nBUT, if you set `FALLBACK_IN_DIR=true`, you can create a single `_fallback.json` file, and it will be used for all files in the directory that do not have an accompanying JSON file. Example:\n\n```\n_fallback.json\nbank.csv\nanother_csv_file.csv\nanother_csv_file.json\nno_config.csv\nsome_xml_file.xml\nsome_xml_file.json\n```\n\nIn the list above, both `bank.csv` and `no_config.csv` will be imported using the `_fallback.json` file.\n",
      "documentId": "how-to/data-importer/advanced/post",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/post/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/post/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/advanced/notifications/index.md",
      "kind": "page",
      "title": "How to set up notifications and emails",
      "description": "The data importer can email you the results of the import. This is useful for cron jobs.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/notifications/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/notifications/index.md",
      "file": "how-to/data-importer/advanced/notifications/index.md",
      "searchText": "\n# How to set up notifications and emails {#how-to-set-up-notifications-and-emails}\n\n\nThe data importer can email you the results of the import. This is useful for cron jobs.\n\nIn your `.env.example` file or using Docker environment variables, configure the data importer as follows:\n\n```\nENABLE_MAIL_REPORT=true\n\nMAIL_DESTINATION=YOUR_OWN_EMAIL@example.com\n\nMAIL_MAILER=smtp\nMAIL_HOST=example.com\nMAIL_PORT=25\nMAIL_ENCRYPTION=tls\nMAIL_USERNAME=username\nMAIL_PASSWORD=secret\nMAIL_FROM_ADDRESS=noreply@example.com\n```\n\nUpdate the settings to match your email configuration. The first thing you'll want to update is the `MAIL_MAILER`. The mail mailer indicates the system that is used for mailing. The data importer supports the following mail systems: smtp, sendmail, mailgun, mandrill, sparkpost and log.\n\n*Always* change the `MAIL_FROM_ADDRESS` address. If this is wrong, mail might never work!\n\n\n## log {#log}\n\n\nSet `APP_LOG_LEVEL=debug`, and the system will store messages in your log files instead of sending them. Since this is not really secure, the log level is `notice` by default.\n\n\n## smtp {#smtp}\n\n\nSMTP is the de-facto standard for sending email. If you want to use GMail or Outlook as mail system, set the mailer to `smtp`. Change the host, port and credentials and, `MAIL_ENCRYPTION` must be `null`, `ssl` or `tls`, depending on your provider.\n\n\n## sendmail {#sendmail}\n\n\nUses the built-in sendmail configuration. If you choose this, you can leave the other values alone.\n\n\n## mailgun {#mailgun}\n\n\n[Mailgun](https://www.mailgun.com/) is an API that can send emails. Their service allows for 10,000 free messages each month.\n\nTo configure these, fill in the `MAILGUN_DOMAIN`, `MAILGUN_SECRET`, and `MAILGUN_ENDPOINT`  values in your `.env` file. The `MAILGUN_DOMAIN` is the domain you've verified with Mailgun, the `MAILGUN_SECRET` is your Mailgun API key, and the `MAILGUN_ENDPOINT` is the Mailgun API endpoint, `api.mailgun.net`, if you are sending email from Mailgun's U.S. infrastructure, or `api.eu.mailgun.net`, from their EU infrastructure. `MAIL_FROM` must be set to an email address that is from your Mailgun's verified domain.\n\n\n## mandrill {#mandrill}\n\n\n[Mandrill](https://www.mandrill.com/) is a paid service by MailChimp. Find the `MANDRILL_SECRET` and fill it in. That should be enough to enable email over Mandrill. Note that I haven't actually tested this.\n\n\n## sparkpost {#sparkpost}\n\n\n[Sparkpost](https://www.sparkpost.com/) is another paid service. Find the `SPARKPOST_SECRET` to configure sending email over Sparkpost. Note that I haven't actually tested this. \n",
      "documentId": "how-to/data-importer/advanced/notifications",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/notifications/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/notifications/index.md"
        }
      ]
    },
    {
      "id": "how-to/data-importer/advanced/custom-import-tag/index.md",
      "kind": "page",
      "title": "How to set a custom import tag",
      "description": "You can set a custom import tag, either in your configuration file or using the UI.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/custom-import-tag/",
      "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/custom-import-tag/index.md",
      "file": "how-to/data-importer/advanced/custom-import-tag/index.md",
      "searchText": "\n# How to set a custom import tag {#how-to-set-a-custom-import-tag}\n\n\nYou can set a custom import tag, either in your configuration file or using the UI.\n\nThe standard tag is something like `Data Import at 2023-06-12 @ 23:03` which may not be very distinctive.\n\nInstead, you can set this to `Cool import by me` or combine it with some of the following custom variables. For example, by setting it to `Imported in year %year%`, the resulting tag will read `Imported in the year 2023`.\n\n\n## Custom variables {#custom-variables}\n\n\nYou can use the following variables in your custom import tag:\n\n| Variable     | Description                      |\n|--------------|----------------------------------|\n| `%year%`     | The year of the import.          |\n| `%month%`    | The month of the import.         |\n| `%day%`      | The day of the import.           |\n| `%hour%`     | The hour of the import.          |\n| `%minute%`   | The minute of the import.        |\n| `%second%`   | The second of the import.        |\n| `%date%`     | The date of the import.          |\n| `%time%`     | The time of the import.          |\n| `%datetime%` | The date and time of the import. |\n| `%version%`  | The version of the importer.     |\n\n",
      "documentId": "how-to/data-importer/advanced/custom-import-tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/custom-import-tag/",
          "markdown": "https://sourcey-firefly.pages.dev/how-to/data-importer/advanced/custom-import-tag/index.md"
        }
      ]
    },
    {
      "id": "references/index.md",
      "kind": "page",
      "title": "Reference guides",
      "description": "These pages will give you more information on the (inner) workings of Firefly III, the API and other things.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/",
      "markdown": "https://sourcey-firefly.pages.dev/references/index.md",
      "file": "references/index.md",
      "searchText": "\n# Reference guides {#reference-guides}\n\n\nThese pages will give you more information on the (inner) workings of Firefly III, the API and other things.\n\nPopular pages include:\n\n1. The [API](/references/firefly-iii/api/)\n2. [Third-party apps](/references/firefly-iii/third-parties/apps/)\n3. Options and settings for [rules](/references/firefly-iii/rule-triggers/) and [search](/references/firefly-iii/search/).\n\n\n## Missing something? {#missing-something}\n\n\n1. You're missing a specific reference guide or information, and you wish to write it\n2. You don't want to write it, but you still miss specific references\n3. You spot inaccuracies, terrible grammar or spelling mistakes\n\nPlease open an [issue on GitHub](https://github.com/firefly-iii/firefly-iii/issues/new?assignees=&labels=&projects=&template=fr.yml). Your contributions are appreciated.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nCheck out the [support page](/explanation/support/).\n",
      "documentId": "references",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/",
          "markdown": "https://sourcey-firefly.pages.dev/references/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/cli/index.md",
      "kind": "page",
      "title": "Command line / CLI",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/cli/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/cli/index.md",
      "file": "references/firefly-iii/cli/index.md",
      "searchText": "\n# Command line / CLI {#command-line--cli}\n\n\nFirefly III has a bunch of CLI commands that you can use. Generally speaking these are meant for large operations. Here's a full overview.\n\nSee also: [How to use the CLI](/how-to/firefly-iii/features/cli/).\n\n\n## List all commands {#list-all-commands}\n\n\n`php artisan`\n\nPlease note that this will also list all the internal upgrade commands Firefly III uses.\n\n\n## Apply rules {#apply-rules}\n\n\n`php artisan firefly-iii:apply-rules`\n\nThis command will apply your rules and rule groups on a selection of your transactions. To use it, add the following parameters:\n\n* `--user[=USER]`. The user ID. [default: \"1\"]\n* `--token[=TOKEN]`. The user's access token. Take this from the `/profile` page.\n* `--accounts[=ACCOUNTS]`. A comma-separated list of asset accounts or liabilities to apply your rules to.\n* `--rule_groups[=RULE_GROUPS]`. A comma-separated list of rule groups to apply. Take the ID's of these rule groups from the Firefly III interface.\n* `--rules[=RULES]`. A comma-separated list of rules to apply. Take the ID's of these rules from the Firefly III interface. Using this option overrules the option that selects rule groups.\n* `--all_rules`. If set, will overrule both settings and apply ALL of your rules.\n* `--start_date[=START_DATE]`. The date of the earliest transaction to be included (inclusive). If omitted, will be your very first transaction ever. Format: YYYY-MM-DD\n* `--end_date[=END_DATE]`. The date of the latest transaction to be included (inclusive). If omitted, will be your latest transaction ever. Format: YYYY-MM-DD\n\nFor more information about rules, see also [how to use rules](/how-to/firefly-iii/features/rules/).\n\n\n## Cronjob {#cronjob}\n\n\n`php artisan firefly-iii:cron`\n\nFires the cronjob. See also [how to set up the cron job](/how-to/firefly-iii/advanced/cron/).\n\n\n## Export data {#export-data}\n\n\n`php artisan firefly-iii:export-data`\n\nAllows you to export all Firefly III data. To use it, add the following parameters:\n\n* `--user[=USER]`. The user ID that the export should run for. [default: \"1\"]\n* `--token[=TOKEN]`. The user's access token.\n* `--start[=START]`. First transaction to export. Defaults to your very first transaction. Only applies to transaction export.\n* `--end[=END]`. Last transaction to export. Defaults to today. Only applies to transaction export.\n* `--accounts[=ACCOUNTS]`. From which accounts or liabilities to export. Only applies to transaction export. Defaults to all of your asset accounts.\n* `--export_directory[=EXPORT_DIRECTORY]`. Where to store the export files. [default: \"./\"]\n* `--export-transactions`. Create a file with all your transactions and their metadata. This flag and the other flags can be combined.\n* `--export-accounts`. Create a file with all your accounts and some metadata.\n* `--export-budgets`. Create a file with all your budgets and some metadata.\n* `--export-categories`. Create a file with all your categories and some metadata.\n* `--export-tags`. Create a file with all your tags and some metadata.\n* `--export-recurring`. Create a file with all your recurring transactions and some metadata.\n* `--export-rules`. Create a file with all your rules and some metadata.\n* `--export-subscriptions`. Create a file with all your subscriptions and some metadata.\n* `--export-piggies`. Create a file with all your piggy banks and some metadata.\n* `--force`. Force overwriting of previous exports if found.\n\nKeep in mind that on Docker, you must export to `./storage/export` to have the files available on your own system.\n\nSee also [how to export data](/tutorials/firefly-iii/exporting-data/).\n",
      "documentId": "references/firefly-iii/cli",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/cli/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/cli/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/account-types/index.md",
      "kind": "page",
      "title": "Account types",
      "description": "These are the account types in Firefly III.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/account-types/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/account-types/index.md",
      "file": "references/firefly-iii/account-types/index.md",
      "searchText": "\n# Account types {#account-types}\n\n\nThese are the account types in Firefly III.\n\nSee also:\n\n- [An explanation about accounts](/explanation/financial-concepts/accounts/)\n- [An explanation about liabilities](/explanation/financial-concepts/liabilities/)\n- [A reference of all transaction types](/references/firefly-iii/transaction-types/)\n- [How to manage accounts](/how-to/firefly-iii/finances/accounts/)\n- [How to reconcile accounts](/how-to/firefly-iii/finances/reconcile/)\n- [How to manage liabilities](/how-to/firefly-iii/finances/liabilities/)\n- [Tutorial: create accounts and transactions](/tutorials/finances/first-steps/)\n- [Tutorial: manage your mortgage](/tutorials/finances/mortgage/)\n\n\n## Asset accounts {#asset-accounts}\n\n\nAsset accounts are normal bank accounts. These accounts can be created with an initial (negative) balance. Asset accounts come in a few flavours.\n\n\n### Default asset accounts {#default-asset-accounts}\n\n\nThis is the default kind of asset account.\n\n\n### Shared asset accounts {#shared-asset-accounts}\n\n\nShared asset accounts are shared with a partner, roommate or spouse. Use this to indicate that both (all) of you have access to this account. You can't actually share access between accounts yet.\n\n\n### Savings account {#savings-account}\n\n\nA type to indicate it's a savings account.\n\n\n### Cash wallet {#cash-wallet}\n\n\nCan be used to track cash expenses.\n\n\n### Credit cards {#credit-cards}\n\n\nIndicate the asset account belongs to a credit card. Firefly III does not (yet) respond to this, it's for your own administration only. Firefly III does not use liability accounts for credit cards.\n\n\n## Expense accounts {#expense-accounts}\n\n\nWhen you spend money, you do so at a store, online or maybe using cash. Each of these places gets its own expense account. You can combine multiple stores into a single expense account if you want.\n\n\n## Revenue accounts {#revenue-accounts}\n\n\nAnother type of account is the revenue account. A revenue account belongs to anyone or any company that sends you money. These may be your employer, parents or friends. Possibly these are clients or the government.\n\n\n\n> [!IMPORTANT]\n> Expense and revenue accounts may share the same name. If you get a refund from Amazon, you will have both an expense account and a revenue account called \"Amazon\".\n\n\n\n\n## Cash accounts {#cash-accounts}\n\n\nIf you want to track your cash expenses specifically, use a cash wallet asset account, as you can read under \"asset accounts\". In most cases, cash money is different from \"normal\" money. When you withdraw money from an ATM and register it in Firefly III, _don't_ register an expense account. Leave the field empty. This will make Firefly III fall back to a specially designed \"cash account\".\n\nLikewise, if you deposit cash into an asset account, don't mention a revenue account (see below).\n\n\n## Liabilities {#liabilities}\n\n\nAll liabilities work the same way. There are three types, meant to distinguish them:\n\n- Loan\n- Debt\n- Mortgage\n\nFor all types, you can set the start of the debt and the initial amount. You can also set the interest rate and the period over which interest is paid. Firefly III will not automatically calculate the result however, these fields are for your own administration.\n",
      "documentId": "references/firefly-iii/account-types",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/account-types/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/account-types/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/transaction-types/index.md",
      "kind": "page",
      "title": "Transaction types",
      "description": "Withdrawals are meant to record expenses. The source account of each withdrawal is an asset account, and the destination account is an expense account.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/transaction-types/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/transaction-types/index.md",
      "file": "references/firefly-iii/transaction-types/index.md",
      "searchText": "\n# Transaction types {#transaction-types}\n\n\n\n## Withdrawals {#withdrawals}\n\n\nWithdrawals are meant to record expenses. The source account of each withdrawal is an asset account, and the destination account is an expense account.\n\nTo create a withdrawal select a source account first. This should be an [asset account](/references/firefly-iii/account-types/) or a [liability](/references/firefly-iii/account-types/). Then select a destination account (an expense account) or free-type a new one. Withdrawals can also be assigned a [budget](/how-to/firefly-iii/finances/budgets/).\n\nAlthough the form allows you to free-type a destination account as well, this may fail and the transaction can't be saved.\n\nIf you want to store cash withdrawals, be sure to read [how to manage cash](/how-to/firefly-iii/finances/cash/).\n\nTransactions from asset accounts to expense accounts or liabilities are considered withdrawals.\n\n\n## Deposits {#deposits}\n\n\nWhen you wish to create a deposit, select a revenue account first, as the source account. When it doesn't exist yet, free-type your own input, and it will be created for you. Then, select an [asset account](/references/firefly-iii/account-types/) or a [liability](/references/firefly-iii/account-types/) as the destination account. If the source account already exists the form will recognize that you're creating a deposit, and the \"budget\"-selector will disappear.\n\nAlthough the form allows you to free-type a destination account as well, this may fail and the transaction can't be saved.\n\nIf you want to store cash deposits, be sure to read [how to manage cash](/how-to/firefly-iii/finances/cash/).\n\nTransactions from revenue accounts or from liabilities TO asset accounts are considered deposits.\n\n\n## Transfers {#transfers}\n\n\nA transfer is created only between existing asset accounts or liabilities. Select an asset account for both the source and destination from the free-form fields. Transfers can be linked to [piggy banks](/how-to/firefly-iii/finances/piggy-banks/), to automatically add or remove money from the piggy bank you select.\n\nTransactions between asset accounts or between liabilities are considered transfers. So, from one asset account to another, that's a transfer. From one liability to another, the same.\n\n\n## Special transaction types {#special-transaction-types}\n\n\nYou won't spot these transaction types in the UI, but they exist nonetheless.\n\n\n### Opening balance {#opening-balance}\n\n\nWhen you create a new asset account, you can set an opening balance. This is a special transaction type that is created when you create the account. It's a deposit into (or withdrawal from) the account, and the source account is the \"opening balance account\". This account is created automatically when you create your first asset account.\n\n\n### Reconciliation {#reconciliation}\n\n\nWhen you reconcile an account, Firefly III creates a special transaction of this type, to store the difference.\n\n\n### Liability credit {#liability-credit}\n\n\nWhen you create a liability account, you can set a start debt. This amount is recorded using the liability credit transaction type.\n",
      "documentId": "references/firefly-iii/transaction-types",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/transaction-types/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/transaction-types/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/search/index.md",
      "kind": "page",
      "title": "Search",
      "description": "The search engine will search in the description of transactions only. Other filters are possible, and are listed below.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/search/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/search/index.md",
      "file": "references/firefly-iii/search/index.md",
      "searchText": "\n# Search {#search}\n\n\nThe search engine will search in the description of transactions only. Other filters are possible, and are listed below.\n\nThe search does not support `OR`, all queries are joined as `AND` queries (A and B and C).\n\n\n## How it works {#how-it-works}\n\n\nIn the future, I hope to make it easier to apply these to your search.\n\nAll search filters work like this:\n\n- `example:value` for basic words\n- `example:\"long value\"` for words with spaces\n- `example:123` for numbers\n- `example:123.45` for numbers with decimals\n- `example:2023-09-17` for dates\n- `-example:value` for the negation of a search filter. It works on all previous examples too.\n\n\n## Description and content {#description-and-content}\n\n\n1. Description: `description_is`, `description_contains`, `description_starts`, `description_ends`\n2. Notes: `notes_are`, `notes_contain`, `notes_start`, `notes_end`\n3. Attachment name: `attachment_name_is`, `attachment_name_contains`, `attachment_name_starts`, `attachment_name_ends`\n4. Attachment notes: `attachment_notes_are`, `attachment_notes_contain`, `attachment_notes_start`, `attachment_notes_end`\n\nTo negate any of these, just add a `-`. The search would become (for example): \"description does not start with\".\n\n\n## Properties {#properties}\n\n\nThese search options search for properties of the transaction in question.\n\n1. Type. Accepts English terms only: \"withdrawal\", \"deposit\" or \"transfer\": `type:withdrawal`\n2. If the transaction is reconciled: `reconciled:true`\n3. If it has any attachments: `has_attachments:true`\n4. If it has a (any) category: `has_any_category:true`\n5. If it has a (any) budget: `has_any_budget:true`\n6. If it has a (any) subscription: `has_any_subscription:true`\n7. If it has a (any) tag: `has_any_tag:true`\n8. If it has (any) notes: `has_any_notes:true`\n9. If it has an external URL: `has_any_external_url:true`\n10. If it has an external ID: `has_any_external_id:true`\n11. ID of the transaction: `id:123`\n12. ID of the transaction journal: `journal_id:123`\n13. ID of the associated recurring transaction: `recurrence_id:123`\n14. If the transaction exists. This particular trigger is always true, and when you inverse it, always false: `exists:true`\n\nWhen you inverse these search options, they look for the opposite property.\n\n\n## Amount {#amount}\n\n\nAll amount search options can handle bigger than, less than, exactly, etc.\n\n1. Amount: `amount:123.45`, `more:123.45`, `less:123.45`\n2. Foreign amount: `foreign_amount:123.45`, `foreign_amount_more:123.45`, `foreign_amount_less:123.45`\n\nAlso present are search options for the currency of the transaction.\n\n1. Currency is: `currency_is:EUR`\n2. Foreign currency is: `foreign_currency_is:USD`\n\n\n## Account {#account}\n\n\nThese search for the source and/or destination account of the transaction.\n\n\n### Source and/or destination {#source-andor-destination}\n\n\n- `account_id`, triggers on any account ID\n- `account_is`, triggers on the exact name.\n- `account_contains`, triggers on any account name that contains the value.\n- `account_starts`, triggers on any account name that starts with the value.\n- `account_ends`, triggers on any account name that ends with the value.\n- `account_is_cash:true`, triggers when any account is the cash account\n\n\n### Source and/or destination account number (or IBAN) {#source-andor-destination-account-number-or-iban}\n\n\nThese search options are the same as above, but for the account number or IBAN.\n\n- `account_nr_is`, triggers on the exact account number.\n- `account_nr_contains`, triggers on any account number that contains the value.\n- `account_nr_starts`, triggers on any account number that starts with the value.\n- `account_nr_ends`, triggers on any account number that ends with the value.\n\n\n### Source account {#source-account}\n\n\nAll these search options also work for the source account when you use `source_account_` instead of `account_`.\n\n\n### Destination account {#destination-account}\n\n\nAll these search options also work for the destination account when you use `destination_account_` instead of `account_`.\n\n\n## Meta-data {#meta-data}\n\n\nMeta-data includes all other data related to the transaction. All the following search options have varieties: starts with, ends on, contains, is exactly.\n\n1. A (any) tag: `tag_is`, `tag_contains`, `tag_starts`, `tag_ends`\n2. SEPA CT: `sepa_ct_is`\n3. Category: `category_is`, `category_contains`, `category_starts`, `category_ends`\n4. Budget: `budget_is`, `budget_contains`, `budget_starts`, `budget_ends`\n5. Subscription: `subscription_is`, `subscription_contains`, `subscription_starts`, `subscription_ends`\n6. External ID: `external_id_is`, `external_id_contains`, `external_id_starts`, `external_id_ends`\n7. Internal reference: `internal_reference_is`, `internal_reference_contains`, `internal_reference_starts`, `internal_reference_ends`\n8. External URL: `external_url_is`, `external_url_contains`, `external_url_starts`, `external_url_ends`\n\n\n## Date and time {#date-and-time}\n\n\nAll of these date and time search options can handle \"on\", \"before\" and \"after\" varieties:\n\n1. Transaction date: `date_on`, `date_before`, `date_after`\n2. Interest date: `interest_date_on:2023-01-01`, ...\n3. Book date: `book_date_on:2023-01-01`, ...\n4. Process date: `process_date_on:2023-01-01`, ...\n5. Due date: `due_date_on:2023-01-01`, ...\n6. Payment date: `payment_date_on:2023-01-01`, ...\n7. Invoice date: `invoice_date_on:2023-01-01`, ...\n8. Created at date: `created_at_on:2023-01-01`, ...\n9. Updated at date: `updated_at_on:2023-01-01`, ...\n\n\n### Keywords {#keywords}\n\n\nYou can use several keywords for dates. It may make it easier to search for relative periods.\n\n- `today`, `yesterday` or `tomorrow`\n- `start of this week`, `start of this month`, `start of this quarter` or `start of this year`\n- `end of this week`, `end of this month`, `end of this quarter`, `end of this year`\n\n\n### Absolute date {#absolute-date}\n\n\nYou can use an absolute date, in this form: `YYYY-MM-DD`. So for the 17th of May 2020, you would use `2020-05-17`.\n\n\n### Relative dates {#relative-dates}\n\n\nYou can also use relative date indicators, like so:\n\n- `\"+3d\"` (in three days)\n- `\"-2w\"` (two weeks ago)\n\nYou can use `d` for days, `w` for weeks, `m` for months and `y` for years. You can also combine them. To creatre a search for a year and a half ago, you could do this:\n\n- `date_is:\"-1y -6m\"`\n\nNotice the **space** between the two date indicators and the added quotes.\n\nLikewise, you can mix + and -. To go 11 months back, you could use:\n\n- `\"-1y +1m\"`\n\nIf your entry is invalid, the search may not work.\n\n\n### Semi specific dates {#semi-specific-dates}\n\n\nI wasn't sure what to call this, but the following date searches can be used:\n\n- On the 10th day of the month\n- In february\n- In 2019\n- On the 5th of June, whatever the year.\n\nYou can do this with the format `xxxx-xx-xx` where you change any set of `xx` into your desired outcome. The format is `year-month-day`. Keep in mind that the other `xx` pairs stay `xx` and need no change. Here are some examples:\n\n- `xxxx-xx-10`. Will search for transactions on the 10th day of any month.\n- `xxxx-04-xx`. Will search for transactions on any date in April, no matter the year or the day.\n- `2018-xx-xx`. Will search for transactions on any date in 2018.\n\nYou can also make some advanced combinations:\n\n- `2017-xx-03`. Will search for transactions on the 3rd of the month, but only in 2017.\n- `2018-09-xx`. Will search for transactions on any day in September 2018.\n- `xxxx-08-07`. Will search for transactions on August 7th, whatever the year.\n\nSo you could say \"Transaction date is before\" `xxxx-xx-10` and any transaction before the 10th of the month is found by the search.\n\n\n\n> [!IMPORTANT]\n> These semi specific dates are tricky. The `xx`-values will be filled in by the date of the transaction. If your search has something like \"2018-xx-xx\" it will never match transactions from any year except 2018.\n\n\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nIf you are missing a specific search option, please check out the [support](/explanation/support/) page.\n",
      "documentId": "references/firefly-iii/search",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/search/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/search/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/rule-triggers/index.md",
      "kind": "page",
      "title": "Rule triggers",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-triggers/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-triggers/index.md",
      "file": "references/firefly-iii/rule-triggers/index.md",
      "searchText": "\n# Rule triggers {#rule-triggers}\n\n\nThe Firefly III rule engine can trigger on a number of things. If you are missing a specific trigger, please check out the [support](/explanation/support/) page.\n\nIf you want to know more, please check out [how to create a rule](/how-to/firefly-iii/features/rules/).\n\n\n\n> [!IMPORTANT]\n> **Trigger inversion**\n>\n> All triggers can be inverted. By checking the \"NOT\"-box on the rule creation page, the trigger will do the opposite, i.e. NOT match on a description.\n\n\n\n\n\n## Description and content {#description-and-content}\n\n\nTriggers that match on textual content. All triggers have varieties: starts with, ends on, contains, is exactly.\n\n1. Description\n2. Notes\n3. Attachment name\n4. Attachment notes\n\n\n## Properties {#properties}\n\n\nProperties of the transaction in question.\n\n1. Type. Accepts English terms only: \"withdrawal\", \"deposit\" or \"transfer\"\n2. If the transaction is reconciled\n3. If it has any attachments\n4. If it has a (any) category\n5. If it has a (any) budget\n6. If it has a (any) subscription\n7. If it has a (any) tag\n8. If it has (any) notes\n9. If it has an external URL\n10. If it has an external ID\n11. ID of the transaction\n12. ID of the transaction journal\n13. ID of the associated recurring transaction\n14. If the transaction exists. This particular trigger is always true, and when you inverse it, always false.\n\nWhen you inverse these triggers, they look for the opposite property.\n\n\n## Amount {#amount}\n\n\n\n\n> [!WARNING]\n> Always write amounts with **dots**, not commas. This also applies when your own language (like Dutch or German) would normally use commas.\n\n\n\nAll amount triggers can handle bigger than, less than, exactly, etc.\n\n1. Amount\n2. Foreign amount\n\nAlso present are filters for the currency of the transaction.\n\n1. Currency is\n2. Foreign currency is.\n\n\n## Account {#account}\n\n\nTrigger on the source and/or destination account of the transaction.\n\nAll the following triggers have varieties: starts with, ends on, contains, is exactly.\n\n1. Source and/or destination account ID\n2. Source and/or destination account name\n3. Source and/or destination account IBAN\n4. Source and/or destination account number\n\nYou can also trigger on:\n\n1. Source and/or destination account is the \"cash\" account\n\n\n## Meta-data {#meta-data}\n\n\nMeta-data includes all other data related to the transaction. All the following triggers have varieties: starts with, ends on, contains, is exactly.\n\n1. A (any) tag.\n2. SEPA CI\n3. Category\n4. Budget\n5. Subscription\n6. External ID\n7. Internal reference\n8. External URL\n\n\n\n## Date and time {#date-and-time}\n\n\nAll of these date and time triggers can handle \"on\", \"before\" and \"after\" varieties.\n\n1. Transaction date\n2. Interest date\n3. Book date\n4. Process date\n5. Due date\n6. Payment date\n7. Invoice date\n8. Created at date\n9. Updated at date\n\n\n### Keywords {#keywords}\n\n\nYou can use several keywords:\n\n- `today`, `yesterday` or `tomorrow`\n- `start of this week`, `start of this month`, `start of this quarter` or `start of this year`\n- `end of this week`, `end of this month`, `end of this quarter`, `end of this year`\n\n\n### Absolute date {#absolute-date}\n\n\nYou can also use an absolute date, in this form: `YYYY-MM-DD`. So for the 17th of May 2020, you would use `2020-05-17`.\n\n\n### Relative dates {#relative-dates}\n\n\nYou can also use relative date indicators, like so:\n\n- `+3d` (in three days)\n- `-2w` (two weeks ago)\n\nYou can use `d` for days, `w` for weeks, `m` for months and `y` for years. You can also combine them. To set a date trigger for a year and a half ago, you could do this:\n\n- `-1y -6m`\n\nNotice the **space** between the two.\n\nLikewise, you can mix + and -. To go 11 months back, you could use:\n\n- `-1y +1m`\n\nIf your entry is invalid, you can't save the rule.\n\n\n### Semi specific dates {#semi-specific-dates}\n\n\nI wasn't sure what to call this, but the following date triggers can be set:\n\n- On the 10th day of the month\n- In february\n- In 2019\n- On the 5th of June, whatever the year.\n\nYou can do this with the format `xxxx-xx-xx` where you change any set of `xx` into your desired outcome. The format is `year-month-day`. Keep in mind that the other `xx` pairs stay `xx` and need no change. Here are some examples:\n\n- `xxxx-xx-10`. Will trigger on the 10th day of any month.\n- `xxxx-04-xx`. Will trigger for any date in April, no matter the year or the day.\n- `2018-xx-xx`. Will trigger for any date in 2018.\n\nYou can also make some advanced combinations:\n\n- `2017-xx-03`. Will trigger on the 3rd of the month, but only in 2017.\n- `2018-09-xx`. Will trigger on any day in September 2018.\n- `xxxx-08-07`. Will trigger on August 7th, whatever the year.\n\nSo you could say \"Transaction date is before\" `xxxx-xx-10` and any transaction before the 10th of the month is triggered.\n\n\n\n> [!IMPORTANT]\n>\n\n\n   These semi specific dates are tricky. The `xx`-values will be filled in by the date of the transaction. If your rule trigger has something like \"2018-xx-xx\" it will never match transactions from any year except 2018.\n\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nIf you are missing a specific trigger, please check out the [support](/explanation/support/) page.\n",
      "documentId": "references/firefly-iii/rule-triggers",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-triggers/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-triggers/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/rule-actions/index.md",
      "kind": "page",
      "title": "Rule actions",
      "description": "Here's a summary of the rule actions you can use.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-actions/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-actions/index.md",
      "file": "references/firefly-iii/rule-actions/index.md",
      "searchText": "\n# Rule actions {#rule-actions}\n\n\nRules, [once triggered](/references/firefly-iii/rule-triggers/) can do a bunch of stuff to your transactions. Make sure to also read [how to use rules](/how-to/firefly-iii/features/rules/). Here are all rule actions. You can see the full list in Firefly III:\n\n![Rule actions](/_media/34a3f7f9e8adaa1092e0.png)\n\nHere's a summary of the rule actions you can use. \n\n\n## Expression engine {#expression-engine}\n\n\nFor most rule actions, you can also use the [expression engine](/how-to/firefly-iii/features/expressions/) to join text together, split text or do other creative stuff. \n\n\n## Set meta data {#set-meta-data}\n\n\nSet the category, budget or tag(s). Link to a subscription or a piggy bank.\n\n\n## Clear meta data {#clear-meta-data}\n\n\nClear the category, budget, all tags or a specific tag.\n\n\n## Description and notes {#description-and-notes}\n\n\nSet the description, or set notes.\n\n\n## Accounts {#accounts}\n\n\nSet the source or destination account. Swap the source and destination account. Set the source or destination to the cash account.\n\n\n## Delete transaction {#delete-transaction}\n\n\nIf you use this action, the transaction will be deleted. There is no undo.\n\n\n## Converting to another transaction type {#converting-to-another-transaction-type}\n\n\nIf you set an action to convert your transaction to a deposit, a transfer or a withdrawal, configure the rule action correctly. If you don't do this right the rule action wil *silently* fail and nothing will happen. Here you can read what will happen to your transaction. This is dependent on the original type and the future type of the transaction.\n\nThese conversions will *not* be applied to split transactions.\n\n\n### From a deposit to a withdrawal {#from-a-deposit-to-a-withdrawal}\n\n\nThe money will be transferred away from the asset account instead of deposited into it. The \"action value\" you must provide must be the name of a valid destination expense account. If it does not exist, it will be created.\n\nIf you leave the action value blank, the new expense account will be named after the revenue account. So, a deposit from \"Your Boss\" becomes a withdrawal at \"Your Boss\".\n\n\n### From a transfer to a withdrawal {#from-a-transfer-to-a-withdrawal}\n\n\nFirefly III will replace the destination asset account with an expense account. So, a transfer from your Checking Account to your Savings Account will be converted into a withdrawal from your Checkings Account to destination Account X, where X is an expense account. The \"action value\" you must provide must be the name of a valid destination expense account. If it does not exist, it will be created.\n\nIf you leave the action value blank, the new expense account will be named after the original destination asset account.\n\n\n### From a withdrawal to a deposit {#from-a-withdrawal-to-a-deposit}\n\n\nThe money will be deposited into the asset account instead of withdrawn from it. The \"action value\" you must provide must be the name of a valid source revenue account. If it does not exist, it will be created.\n\nIf you leave the action value blank, the new revenue account will be named after the original expense account. So, a withdrawal from \"Walmart\" becomes a deposit from \"Walmart\".\n\n\n### From a transfer to a deposit {#from-a-transfer-to-a-deposit}\n\n\nFirefly III will replace the \"source\" asset account with a revenue account. So, a transfer from your Savings Account to your Checking Account will be converted into a deposit into your Checkings Account from source Account X, where X is a revenue account. The \"action value\" you must provide must be the name of a valid revenue account. If it does not exist, it will be created.\n\nIf you leave the action value blank, the new revenue account will be named after the original source asset account.\n\n\n### From a withdrawal to a transfer {#from-a-withdrawal-to-a-transfer}\n\n\nThe money will be moved away from the original asset account, into another asset account. The \"action value\" you must provide must be the name of a valid destination asset account. If it does not exist, the action will fail.\n\nIf you leave the action value empty, the action will fail.\n\n\n### From a deposit to a transfer {#from-a-deposit-to-a-transfer}\n\n\nThe money will be moved into the original asset account, from another asset account. The \"action value\" you must provide must be the name of a valid source asset account. If it does not exist, the action will fail.\n\nIf you leave the action value empty, the action will fail.\n",
      "documentId": "references/firefly-iii/rule-actions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-actions/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-actions/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/rule-expressions/index.md",
      "kind": "page",
      "title": "Rule expressions",
      "description": "Firefly III features a powerful rule engine that comes with an expression language to execute actions on your transactions.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-expressions/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-expressions/index.md",
      "file": "references/firefly-iii/rule-expressions/index.md",
      "searchText": "\n# Rule expressions {#rule-expressions}\n\n\n\n\n> [!WARNING]\n> **Use of Expressions**\n>\n> This feature requires 6.1.20 or later and must be manually enabled in 'System Settings - Firefly III Configuration - Enable expression engine' with versions > 6.7.x\n\n\n\nFirefly III features a powerful [rule engine](/how-to/firefly-iii/features/rules/) that comes with an [expression language](/how-to/firefly-iii/features/expressions/) to execute actions on your transactions.\n\n\n\n> [!IMPORTANT]\n> **Full syntax**\n>\n> The full syntax of the expression language is documented in the [Symfony documentation](https://symfony.com/doc/current/reference/formats/expression_language.html).\n\n\n\nThe expression language features something called \"variables\" that you can use in your expression. For example:\n\n```plaintext\n=description~notes\n```\n\nThis will join the description and the notes together. A few examples can be found on the pages linked earlier in the text. But then the question becomes, which variables can I use? Well, here they are.\n\n\n## Text fields {#text-fields}\n\n\n- `notes`\n- `transaction_group_title`\n- `description`\n- `budget_name`\n- `category_name`\n- `tags`\n\nUse these fields to refer to specific fields in the transaction\n\n\n## Account and amount fields {#account-and-amount-fields}\n\n\nAmount fields:\n\n- `amount`\n- `currency_code`\n- `currency_name`\n- `currency_symbol`\n- `currency_decimal_places`\n- `foreign_amount`\n- `foreign_currency_code`\n- `foreign_currency_name`\n- `foreign_currency_symbol`\n- `foreign_currency_decimal_places`\n\nAccount fields: \n\n- `source_account_id`\n- `source_account_name`\n- `source_account_iban`\n- `source_account_type`\n- `destination_account_id`\n- `destination_account_name`\n- `destination_account_iban`\n- `destination_account_type`\n\n\n## Dates {#dates}\n\n\n- `created_at`\n- `updated_at`\n- `group_created_at`\n- `group_updated_at`\n- `date`\n- `interest_date`\n- `payment_date`\n- `invoice_date`\n- `book_date`\n- `due_date`\n- `process_date`\n\nThese fields contain specific transaction dates, or \"\" when empty.\n",
      "documentId": "references/firefly-iii/rule-expressions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-expressions/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/rule-expressions/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/api/index.md",
      "kind": "page",
      "title": "API",
      "description": "Firefly III features a JSON API.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/index.md",
      "file": "references/firefly-iii/api/index.md",
      "searchText": "\n# API {#api}\n\n\nSee also:\n\n- [How to talk to the API](/how-to/firefly-iii/features/api/)\n\nFirefly III features a JSON API.\n\nPlease visit the [API reference](/api/), where you can read and try the API. [A PHP library](https://github.com/StanSoftBG/oauth2-firefly-iii) was developed by [StanSoft.BG Ltd.](https://github.com/StanSoftBG) that you can use to talk to Firefly III in PHP.\n\nThe API is slated to become the only way to talk to Firefly III: even the UI would use the API exclusively. Alas, this is a work in progress.\n\n\n## Developing with the Firefly III API {#developing-with-the-firefly-iii-api}\n\n\nIf you want to keep up with changes to the Firefly III API, be sure to sign up to [the Firefly III dev mailing list](https://firefly-iii.kit.com/dev). It's free and low-frequency.\n\n\n## Currencies in the API {#currencies-in-the-api}\n\n\nAll objects where currency is relevant have `currency_*` attributes. They refer to the currency set in the object. Most objects (accounts, transactions, etc.) carry their own currency settings. For example, a bill or a piggy bank has its own currency, regardless of the primary currency of the administration. Expect something like this:\n\n![Currency attributes](/_media/f1428cd6716065038435.png)\n\nAlso visible is the `object_has_currency_setting` setting which confirms this particular object has its own currency setting. This is true for most objects, such as accounts, transactions, bills, budgets, etc. However, some objects do not have their own currency setting, such as categories or tags. In those cases, the `object_has_currency_setting` will be `false`.\n\nAll objects where currency is relevant have `primary_currency_*` attributes. These refer to the primary currency of the financial administration. They may be different from the currency set in the object. For example, a transaction may be in USD, but the primary currency is EUR. This is important for conversions and exchange rates.\n\n\n![Primary attributes](/_media/0a658a96f0344c2e2c93.png)\n\nAmounts, balances and collections of expenses (such as `spent` or `earned` arrays) will always be in the currency of the associated object. For example, a transaction in USD will have amounts in USD, even when the primary currency is EUR. The API also returns all of these fields as `pc_*` attributes. These are the \"converted to **p**rimary **c**urrency\" attributes. If the user enables \"convert to primary\", these fields will contain the amounts converted to the primary currency of the financial administration, using the exchange rate set in Firefly III.\n\n![Amount attributes](/_media/967c65607513ee764e96.png)\n\nIf the user does NOT enable \"convert to primary\", all `pc_*` attributes will be `null`. This means that the API will not convert amounts to the primary currency. If the currency of the object is the same as the primary currency, the `pc_*` attributes will be the same as the regular attributes. For example, a transaction in EUR with a primary currency of EUR will have `amount` and `pc_amount` set to the same value.\n\n\n## Configuration values {#configuration-values}\n\n\nThe endpoint `/api/v1/configuration` returns a variety of static and dynamic configuration values of Firefly III.\n\nThere are two sets of configuration values that you can retrieve through this endpoint.\n\n1. Static values. You cannot edit these. The source code of Firefly III has [the full list of options](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Binder/EitherConfigKey.php#L35).\n2. Dynamic values. These can be changed. The source code of Firefly III has [the full list of options](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Binder/DynamicConfigKey.php#L35).\n\n\n## Webhooks {#webhooks}\n\n\nFirefly III supports webhooks, which you can read more about on the page about [webhooks](/how-to/firefly-iii/features/webhooks/).\n\nA webhook needs a title and a URL to work, and three important things.\n\n1. A set of triggers. Use `GET api/v1/configuration/webhook.triggers` to get the available values, because they may change in the future.\n2. A response. Use `GET api/v1/configuration/webhook.responses` to see what is available. New responses may be added in the future.\n3. A delivery format. Use `GET api/v1/configuration/webhook.deliveries` to see what is available. This is only `JSON` right now.\n\nWhen you create a webhook you can choose webhook-specific data to be the response. For example, you trigger your webhook on the creation of a new transaction, and the response is the transaction details.\n\nHowever, when you create a webhook that ALSO triggers on the creation of a new budget, you cannot set the transaction details as the expected response. In that case, you must select the option \"The relevant details\" (`RELEVANT`) which will automatically select the correct data to send as response.\n\nThe reason this is complicated is that some webhook triggers come with multiple possible responses, so it is always up to you to select what you need. However, for some trigger combinations `RELEVANT` is the only possible response. \n\n\n## Differences between versions {#differences-between-versions}\n\n\nI've not always kept a log of all changes between API versions, but for v6.4.0 onwards this is done in the diff files listed below.\n\n- [Diff between v6.3.0 and v6.4.0](https://api-docs.firefly-iii.org/differences/v6.3.0-v6.4.0)\n- [Diff between v6.4.0 and v6.4.1](https://api-docs.firefly-iii.org/differences/v6.4.0-v6.4.1)\n\n",
      "documentId": "references/firefly-iii/api",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/api/specials/index.md",
      "kind": "page",
      "title": "API special endpoints",
      "description": "Some Firefly III API endpoints need a little more guidance than fits in the documentation.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/specials/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/specials/index.md",
      "file": "references/firefly-iii/api/specials/index.md",
      "searchText": "\n# API special endpoints {#api-special-endpoints}\n\n\nSome Firefly III API endpoints need a little more guidance than fits in the documentation.\n\n\n## Transaction update {#transaction-update}\n\n\nUpdating transactions is straight-forward, but updating splits is more complicated.\n\nIf you want to update a split transaction, you must know and submit the `transaction_journal_id` for each split, even if you do not want to change anything in the split. Like so:\n\n```json\n{\n    \"apply_rules\": false,\n    \"fire_webhooks\": false,\n    \"transactions\":\n    [\n        {\n            \"transaction_journal_id\": 1222,\n            \"description\": \"Updated description\"\n        },\n        {\n            \"transaction_journal_id\": 1333\n        }\n    ]\n}\n```\n\nAs you can see, the second transaction will not be updated.\n\n\n\n> [!WARNING]\n> If you do not submit a split, not even its ID, the split will be **deleted**.\n\n\n\n\n\n> [!WARNING]\n> If you submit changes to a split without submitting the `transaction_journal_id`, it will be created as a new split. The previous split will be deleted.\n\n\n\n\n## Bulk transaction update {#bulk-transaction-update}\n\n\nThis is a special endpoint where you can use (very) basic queries to update transactions in a group.\n\nThe `query` parameter is a JSON array with the following format:\n\n```json\n{\n\t\"where\": {\n\t\t\"account_id\": 1\n\t},\n\t\"update\": {\n\t\t\"account_id\": 2\n\t}\n}\n```\n\nThe `where` and `update` objects are mandatory and the only field currently supported for both is `account_id`.\n\nThis will search transactions with `account_id`  = `1` (source OR destination) and change it to `account_id` = `2`.\n",
      "documentId": "references/firefly-iii/api/specials",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/specials/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/api/specials/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/third-parties/host/index.md",
      "kind": "page",
      "title": "Third parties that host Firefly III",
      "description": "Firefly III is available on Hostinger.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/host/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/host/index.md",
      "file": "references/firefly-iii/third-parties/host/index.md",
      "searchText": "\n# Third parties that host Firefly III {#third-parties-that-host-firefly-iii}\n\n\n\n## Hostinger {#hostinger}\n\n\nFirefly III is available on [Hostinger](https://www.hostg.xyz/aff_c?offer_id=815&aff_id=243699&url_id=6810).\n\n\n## PikaPods {#pikapods}\n\n\nFirefly III is available on [PikaPods](https://www.pikapods.com/pods?run=firefly-iii)\n\n\n## LumaDock {#lumadock}\n\n\nFirefly III is available as a one-click installation [on LumaDock](https://lumadock.com/vps-hosting/firefly-iii).\n\n\n## Zenith {#zenith}\n\n\nFirefly III is featured on [Zenith](https://zenith.hosting/host/firefly-iii), which runs the instance for you in one click. Storage, backups, email and a free subdomain are included.\n\n\n## Hostim {#hostim}\n\n\nFirefly III is available [as a one-click template on Hostim](https://console.hostim.dev/dashboard?preview=1&modal=1&template=firefly-iii), a container hosting platform in Germany. The template runs Firefly III with a managed MySQL database, a volume for uploads and a free subdomain with HTTPS. See the [setup guide](https://hostim.dev/docs/templates/firefly-iii) for the cron job.\n\n\n## Pethost {#pethost}\n\n\nFirefly III is available [as a one-click template on Pethost](https://pethost.dev/templates/firefly-iii/). The template runs Firefly III with PostgreSQL, a volume for uploads and a subdomain with HTTPS, and calls the daily cron job for you.\n\n\n## AMPPS {#ampps}\n\n\nFirefly III is featured in [AMPPS](https://www.ampps.com/). You can download AMPPS for Windows, Linux and Mac and Firefly III will be available as a package there.\n\n\n## Cloudron {#cloudron}\n\n\nFirefly III is featured in [Cloudron](https://cloudron.io/). You can install a Cloudron server instance and Firefly III will be available in the [App Store](https://cloudron.io/store/org.fireflyiii.cloudronapp.html).\n\n\n## Umbrel {#umbrel}\n\n\nFirefly III is featured in the [Umbrel app store](https://apps.umbrel.com/app/firefly-iii).\n\n\n## Unraid {#unraid}\n\n\nThere are [templates](https://forums.unraid.net/topic/124146-support-smartphonelover-firefly-iii-data-importer/) for Firefly III and the Data Importer.\n\n\n## Yunohost {#yunohost}\n\n\nFirefly III is featured on [Yunohost](https://apps.yunohost.org/app/firefly-iii).\n\n\n## Softaculous {#softaculous}\n\n\n\n\n> [!WARNING]\n> Your hosting provider may not be compatible with Firefly III, even when it's listed in your Softaculous application list. I cannot support you with this.\n\n\n\nFirefly III is featured in [Softaculous](https://softaculous.com/). If your (hosting) server provides packages using Softaculous, Firefly III will be available as a package there. They even made a special [demo site](http://www.softaculous.com/softaculous/apps/others/Firefly_III).\n\n",
      "documentId": "references/firefly-iii/third-parties/host",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/host/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/host/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/third-parties/apps/index.md",
      "kind": "page",
      "title": "Third-party apps",
      "description": "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!",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/apps/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/apps/index.md",
      "file": "references/firefly-iii/third-parties/apps/index.md",
      "searchText": "\n# Third-party apps {#third-party-apps}\n\n\nThere are a lot of interesting tools and apps built around the [Firefly III API](/references/firefly-iii/api/). Here's a list, in no particular order. Is your (favorite) tool not on the list? Submit a PR!\n\nBe sure to also check out [the list of import tools](/references/data-importer/third-party-tools/).\n\n\n## Home Assistant {#home-assistant}\n\n\n\n### Firefly III Core integration {#firefly-iii-core-integration}\n\n\nA core integration that allows you to integrate Firefly III, shipped with Home Assistant since version 2025.11.\n\n- [Credits](https://github.com/erwindouna)\n- [Documentation](https://www.home-assistant.io/integrations/firefly_iii)\n\n\n### Firefly III HACS integration {#firefly-iii-hacs-integration}\n\n\nA custom integration, developed by community, that allows you to integrate Firefly III into Home Assistant.\n\n- [Credits](https://github.com/soloam)\n- [Documentation](https://github.com/soloam/ha-fireflyiii-integration)\n\n\n## Mobile applications {#mobile-applications}\n\n\n\n### iPhone SMS to Firefly III transaction {#iphone-sms-to-firefly-iii-transaction}\n\n\nThis is a tool that allows you to create transactions in Firefly III by sending an SMS from your iPhone.\n\n- [Credits](https://github.com/mrahmadt)\n- [Receiver](https://github.com/mrahmadt/SMSReceiver-iOS)\n- [Backend](https://github.com/mrahmadt/smartMoney)\n\n\n### Firefly-Pico {#firefly-pico}\n\n\nFirefly-Pico is a web app, optimized for mobile phones, with a focus on clean UI and fast expense tracking.\n\n- [Credits](https://github.com/cioraneanu)\n- [Website and documentation](https://github.com/cioraneanu/firefly-pico)\n\n\n### Waterfly III {#waterfly-iii}\n\n\nWaterfly III is an android app created by @dreautall that connects to your Firefly III installation.\n\n- [Credits](https://github.com/dreautall)\n- [Website and documentation](https://github.com/dreautall/waterfly-iii)\n- [Google Play Store](https://play.google.com/store/apps/details?id=com.dreautall.waterflyiii)\n\n\n### Photuris III {#photuris-iii}\n\n\nPhoturis III is an android app created by @emansih that connects to your Firefly III installation.\n\n- [Credits](https://github.com/emansih)\n- [Website and documentation](https://github.com/emansih/FireflyMobile)\n- [Google Play Store](https://play.google.com/store/apps/details?id=xyz.hisname.fireflyiii)\n- [F-Droid store](https://f-droid.org/packages/xyz.hisname.fireflyiii/)\n\n\n### OCR Firefly Mobile {#ocr-firefly-mobile}\n\n\nOCR Firefly Mobile is a little tool to help you enter transactions into the mobile app automatically.\n\n- [Credits](https://github.com/luifermoron)\n- [Website](https://github.com/luifermoron/ocrFireflyMobile)\n- [Google Play Store](https://play.google.com/store/apps/details?id=com.opensource.autofill)\n\n\n### Abacus App {#abacus-app}\n\n\nAbacus is a mobile app created by @victorbalssa that allows you to use your Firefly III instance from your mobile.\n\n- [Credits](https://github.com/victorbalssa)\n- [GitHub](https://github.com/victorbalssa/abacus)\n- [App Store](https://apps.apple.com/us/app/1627093491)\n- [Google Play Store](https://play.google.com/store/apps/details?id=abacus.fireflyiii.android.app)\n\n\n### Lychnos {#lychnos}\n\n\nLychnos is a simple web front-end for Firefly III made by @davidschlachter, built around annual budgets for categories. Supports creating and viewing transactions alongside its budgeting features.\n\n- [Credits](https://github.com/davidschlachter)\n- [Website and documentation](https://github.com/davidschlachter/lychnos)\n\n\n### Firefly Personal Finance {#firefly-personal-finance}\n\n\nFirefly Personal Finance is an android app created by @mconway that connects to your Firefly III installation.\n\n\n\n> [!WARNING]\n> Development of this tool stopped in January 2020. It may no longer work as expected.\n\n\n\n- [Credits](https://github.com/mconway)\n- [Website and documentation](https://github.com/mconway/firefly-app/)\n- [Google Play Store](https://play.google.com/store/apps/details?id=com.zerobyte.firefly)\n\n\n### Firefly Ledger PWA {#firefly-ledger-pwa}\n\n\nA client-side Progressive Web App for recording and tracking transactions on your Firefly III instance. Works offline, supports multi-currency with auto-conversion, and includes accounts overview with transaction history. Everything runs locally in your browser, no servers, no cloud, no data leaves your device.\n\n- [Credits](https://github.com/mcardielo)\n- [Website and documentation](https://github.com/mcardielo/fireflyiii-pwa)\n\n\n### Money {#money}\n\n\nMoney is a mobile-friendly web app that runs next to your Firefly III server in a small nginx container. It covers most Firefly III features and adds a customizable dashboard, quick add in plain words and a safe-to-spend forecast. Your access token stays on the server.\n\n- [Credits](https://github.com/Muffy0906)\n- [Website and documentation](https://github.com/Muffy0906/firefly-money)\n\n\n### FireFlow {#fireflow}\n\n \nFireFlow is a native iPhone and Apple Watch app created by @antonkrall that connects to your Firefly III installation. You can add transactions with Siri, widgets or receipt scanning, including while offline, and they sync when you reconnect. Your data only goes to your own server.\n \n- [Credits](https://antonkrall.github.io/fireflow-site/)\n- [App Store](https://apps.apple.com/app/id6806560719)\n\n\n## Bots and tools {#bots-and-tools}\n\n\n\n### fireflyiii-mcp {#fireflyiii-mcp}\n\n\nA TypeScript MCP server for Firefly III with 140 tools across 14 groups (accounts, transactions, budgets, categories, bills, piggy banks, rules, recurring transactions, attachments, currencies, exports, object groups, transaction links, and reports). Supports full CRUD, Personal Access Token and OAuth 2.0 authentication, and tool filtering via presets or group selection.\n\n- [Credits](https://github.com/daften)\n- [Repository](https://github.com/daften/fireflyiii-mcp)\n- [npm package](https://www.npmjs.com/package/@daften/fireflyiii-mcp)\n\n\n### Firefly III MCP Server {#firefly-iii-mcp-server}\n\n\nAn MCP server by @YakupEmreYerli that connects AI assistants to Firefly III. Reading, writing and deleting are separate tools, and every write can be previewed before it runs.\n\n- [Credits](https://github.com/YakupEmreYerli)\n- [Repository and documentation](https://github.com/YakupEmreYerli/mcp-firefly-iii)\n- [npm package](https://www.npmjs.com/package/@yakupemreyerli/firefly-mcp)\n\n\n### A TypeScript SDK {#a-typescript-sdk}\n\n\nA TypeScript SDK for Firefly III, automatically generated from the official OpenAPI specification.\n\n- [Credits](https://github.com/Billos)\n- [NPM package](https://www.npmjs.com/package/@billos/firefly-iii-sdk)\n\n\n### Universal Firefly III AI Bridge (MCP Server) {#universal-firefly-iii-ai-bridge-mcp-server}\n\n\nA professional-grade, AI-agnostic Model Context Protocol (MCP) server providing exhaustive 100% API coverage. It allows you to manage your accounts, transactions, budgets, rules, and attachments using natural language via Gemini, Claude, and ChatGPT.\n\n- [Credits](https://github.com/fabianonetto)\n- [Repository and documentation](https://github.com/fabianonetto/mcp-server-firefly-iii)\n\n\n### Firefly III CLI {#firefly-iii-cli}\n\n\nFirefly III Command Line Interface is a tool made by @afonsoc12 that allows you to interact with Firefly III over the command line.\n\n- [Credits](https://github.com/afonsoc12)\n- [Website and documentation](https://github.com/afonsoc12/firefly-cli)\n\n\n### PHP API library {#php-api-library}\n\n\nThe PHP API library is a library developed by StanSoft.BG Ltd that allows you to easily authenticate to Firefly III over OAuth2.0 and use the API in your own app.\n\n- [Credits](https://github.com/StanSoftBG)\n- [Website](https://github.com/StanSoftBG/oauth2-firefly-iii)\n\n\n### AI Categorizer {#ai-categorizer}\n\n\nFirefly III AI Categorizer is a tool developed by @bahuma20 that allows you to automatically categorize your expenses for free by using OpenAI.\n\n- [Credits](https://github.com/bahuma20)\n- [Website](https://github.com/bahuma20/firefly-iii-ai-categorize)\n\n\n### Telegram bot for Firefly III {#telegram-bot-for-firefly-iii}\n\n\nThe Telegram bot for Firefly III can create transactions through Telegram.\n\n- [Credits](https://github.com/cyxou)\n- [Website](https://github.com/cyxou/firefly-iii-telegram-bot)\n\n\n### Firefly Bot {#firefly-bot}\n\n\nThe Firefly Bot can create transactions through Telegram.\n\n- [Credits](https://github.com/vjFaLk)\n- [Website](https://github.com/vjFaLk/firefly-bot)\n\n\n### iOS Shortcut {#ios-shortcut}\n\n\niOS Shortcut to create transactions in Firefly III.\n\n- [Credits](https://github.com/dimarei)\n- [Website](https://github.com/dimarei/firefly-ios-shortcuts)\n\n\n### FFIIITC {#ffiiitc}\n\n\nFFIIITC is a tool that allows you to automatically categorize your transactions using ML and Naive Bayes classifier.\n\n- [Credits](https://github.com/akopulko)\n- [Website](https://github.com/akopulko/ffiiitc)\n\n\n### Firefly III - Sankey Diagram Generator {#firefly-iii---sankey-diagram-generator}\n\n\nFirefly III - Sankey Diagram Generator is a command-line tool that generates Sankey diagrams from your Firefly III financial data.\n\n- [Credits](https://github.com/barreeeiroo)\n- [Website](https://github.com/barreeeiroo/Firefly-III-Sankey)\n\n\n### Toolbox for Firefly III {#toolbox-for-firefly-iii}\n\n\nWeb automation suite for Firefly III. Includes tools for duplicate detection, subscription analysis, AI-powered categorization, bank imports and transaction enrichment via Amazon/PayPal exports.\n\n- [Website](https://github.com/xenolphthalein/toolbox-for-firefly-iii)\n\n\n## Reporting {#reporting}\n\n\n\n### Prometheus Exporter {#prometheus-exporter}\n\n\nAlejandro built a Prometheus exporter for Firefly III.\n\n- [Credits](https://github.com/kinduff)\n- [Repository](https://github.com/kinduff/firefly_iii_exporter)\n\n\n### Summary emails {#summary-emails}\n\n\nDavid built a tool to send you a monthly overview of your expenses by category.\n\n- [Credits](https://github.com/davidschlachter)\n- [Website and documentation](https://github.com/davidschlachter/firefly-iii-email-summary)\n\nYemzikk forked and enhanced this project with some cool new features:\n\n- [Enhanced version by Yemzikk](https://github.com/yemzikk/firefly-iii-email-summary)\n\n\n### Entropy for Firefly III {#entropy-for-firefly-iii}\n\n\nA read-only forecast view for Firefly III that flags recurring transactions that were due but never turned up.\n\n- [Credits](https://github.com/4242labs)\n- [Source](https://github.com/4242labs/ff3e)\n- [Demo](https://ff3e.42labs.io)\n\n\n## Import tools {#import-tools}\n\n\nAll import related tools are listed [on the page on importing data](/references/data-importer/third-party-tools/).\n\n\n## Other tools {#other-tools}\n\n\nOther tools developed by the developer of Firefly III are listed on the [other tools](/explanation/other-tools/) page.\n",
      "documentId": "references/firefly-iii/third-parties/apps",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/apps/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/third-parties/apps/index.md"
        }
      ]
    },
    {
      "id": "references/firefly-iii/changelog/index.md",
      "kind": "page",
      "title": "Change Log",
      "description": "All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/changelog/",
      "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/changelog/index.md",
      "file": "references/firefly-iii/changelog/index.md",
      "searchText": "\n# Change Log {#change-log}\nAll notable changes to this project will be documented in this file.\nThis project adheres to [Semantic Versioning](http://semver.org/).\n\n\n### Added {#added}\n\n\n- Layout `v2` has some new features\n- [Issue 8369](https://github.com/firefly-iii/firefly-iii/issues/8369) (Additional reconcile link) reported by @chevdor\n\n\n### Fixed {#fixed}\n\n\n- [Issue 8352](https://github.com/firefly-iii/firefly-iii/issues/8352) (Modifying the direction of a transfer between liabilities yields no effect) reported by @Ezwen\n- [Issue 8370](https://github.com/firefly-iii/firefly-iii/pull/8370) (Fix various typos) reported by @luzpaz\n- [Issue 8377](https://github.com/firefly-iii/firefly-iii/issues/8377) (Query on multiple tags returns duplicates) reported by @chevdor\n- [Issue 8374](https://github.com/firefly-iii/firefly-iii/issues/8374) (Error Graph Income vs. expenses Reports page) reported by @nicolopozzato\n- [Issue 8390](https://github.com/firefly-iii/firefly-iii/issues/8390) (Rule with destination_account_is 'not' is never returning a result.) reported by @EricVanCaenenberghe\n- [Issue 8349](https://github.com/firefly-iii/firefly-iii/issues/8349) (Currencies not saving correctly) reported by @r1bas4\n- [Issue 8418](https://github.com/firefly-iii/firefly-iii/issues/8418) (Unable to create rule with trigger having type has_no_budget via the API ) reported by @tailg8nj\n- [Issue 8425](https://github.com/firefly-iii/firefly-iii/issues/8425) (Error from the net-worth endpoint with  `Trailing data`.) reported by @chevdor\n- Various Carbon `createFromFormat` issues fixed.\n\n\n## 6.1.6 - 2024-01-07 {#616-2024-01-07}\n\n\n\n### Fixed {#fixed_1}\n\n\n- Type validation error\n\n\n## 6.1.5 - 2024-01-07 {#615-2024-01-07}\n\n\n\n### Added {#added_1}\n\n\n- More audit logs\n- Sanity check in date ranges\n- More uniform length and size validations\n\n\n### Changed {#changed}\n\n\n- Slightly changed text, thanks @maureenferreira!\n\n\n### Fixed {#fixed_2}\n\n\n- [Issue 8328](https://github.com/firefly-iii/firefly-iii/issues/8328) Some extra fixes for non-zero foreign amounts\n- Updated links in `.env.example`, thanks @lemuelroberto!\n\n\n## 6.1.4 - 2024-01-03 {#614-2024-01-03}\n\n\n\n### Fixed {#fixed_3}\n\n\n- [Issue 8328](https://github.com/firefly-iii/firefly-iii/issues/8328) Asking for non-zero foreign amount despite not being used\n\n\n## 6.1.3 - 2024-01-03 {#613-2024-01-03}\n\n\n\n### Fixed {#fixed_4}\n\n\n- [Issue 8326](https://github.com/firefly-iii/firefly-iii/issues/8326) Asking for non-zero foreign amount despite not being used\n\n\n## 6.1.2 - 2024-01-03 {#612-2024-01-03}\n\n\n\n### Changed {#changed_1}\n\n\n- [Issue 8304](https://github.com/firefly-iii/firefly-iii/issues/8304) Several issues with searching for and displaying of tag-related transactions\n\n\n### Removed {#removed}\n\n\n- Double reference to webhooks in the menu\n\n\n### Fixed {#fixed_5}\n\n\n- [Issue 8297](https://github.com/firefly-iii/firefly-iii/issues/8297) Division by zero\n- [Issue 8320](https://github.com/firefly-iii/firefly-iii/issues/8320) nullpointer in new layout\n- [Issue 8321](https://github.com/firefly-iii/firefly-iii/issues/8321) Networth checkbox for expense and revenue accounts removed\n- Long date ranges will throw an error\n- \n- Max sizes and reasonable limits for most numbers and strings\n- Links in readme to documentation.\n\n\n### Security {#security}\n\n\n- Webhooks now properly disabled in the UI.\n- [Issue 8322](https://github.com/firefly-iii/firefly-iii/issues/8322) Duplicate detection did not distinguish between users\n\n\n## 6.1.1 - 2023-12-27 {#611-2023-12-27}\n\n\n\n### Changed {#changed_2}\n\n\n- Rule overview is lower in height.\n\n\n### Removed {#removed_1}\n\n\n- Removed fixed sidebar again\n\n\n### Fixed {#fixed_6}\n\n\n- Nullpointer in rule trigger render code\n- [Issue 8272](https://github.com/firefly-iii/firefly-iii/issues/8272) The sum for expected bills in a group includes unexpected bills as well\n- [Issue 8273](https://github.com/firefly-iii/firefly-iii/issues/8273) Frontpage preferences indicate all accounts are shown on the frontpage, even when not true\n- [Issue 8274](https://github.com/firefly-iii/firefly-iii/issues/8274) Semi specific dates do not work correctly with the \"Transaction date is..\" rule trigger\n- [Issue 8277](https://github.com/firefly-iii/firefly-iii/issues/8277) Expected bill next month, but shown as not expected\n- [Issue 8278](https://github.com/firefly-iii/firefly-iii/issues/8278) Net worth is empty in the dashboard due to division by zero\n- [Issue 8281](https://github.com/firefly-iii/firefly-iii/issues/8281) Database CPU utilization after v6.1.0 upgrade\n- [Issue 8291](https://github.com/firefly-iii/firefly-iii/issues/8291) Multiple \"Any tag is\" (negated or not) rule triggers don't all apply in strict mode\n\n\n### Security {#security_1}\n\n\n- HTML Injection Vulnerability in webhooks code, discovered by @stefan-schiller-sonarsource from Sonar. Thanks!\n\n\n### API {#api}\n\n\n- [Issue 8282](https://github.com/firefly-iii/firefly-iii/issues/8282) Update transaction via API does not update the \"updated_at\" parameter\n\n\n## 6.1.0 - 2023-12-17 {#610-2023-12-17}\n\n\n> ⚠️⚠️ This release required **PHP 8.3.0** and will not work on earlier releases of PHP ⚠️⚠️\n\n\n### Added {#added_2}\n\n\n- [Issue 7571](https://github.com/firefly-iii/firefly-iii/issues/7571) More tag search options\n- [Issue 7781](https://github.com/firefly-iii/firefly-iii/issues/7781) Nice wrapper script for artisan commands\n- UI also supports time for transactions\n\n\n### Changed {#changed_3}\n\n\n- ⚠️⚠️ Requires PHP8.3 ⚠️⚠️\n- [Issue 8148](https://github.com/firefly-iii/firefly-iii/issues/8148) Slovenian language updates\n- [Issue 8023](https://github.com/firefly-iii/firefly-iii/issues/8023) Top bar is now fixed in place\n- Completely rewrote the documentation.\n\n\n### Deprecated {#deprecated}\n\n\n- ⚠️⚠️ Removed support for PHP 8.2 ⚠️⚠️\n\n\n### Fixed {#fixed_7}\n\n\n- [Issue 8106](https://github.com/firefly-iii/firefly-iii/issues/8106) [issue 8195](https://github.com/firefly-iii/firefly-iii/issues/8195) [issue 8163](https://github.com/firefly-iii/firefly-iii/issues/8163) Various changes and fixes to bill date calculation\n- [Issue 8137](https://github.com/firefly-iii/firefly-iii/issues/8137) Fix uneven amount error from cron job\n- [Issue 8192](https://github.com/firefly-iii/firefly-iii/issues/8192) No matching transactions found.Rule with trigger NOT Transaction is reconciled returns\n- [Issue 8207](https://github.com/firefly-iii/firefly-iii/issues/8207) Broken links, thanks @Maxco10!\n- [Issue 8138](https://github.com/firefly-iii/firefly-iii/issues/8138) Reconciled transactions can't be \"store(d) as new\"\n- [Issue 7716](https://github.com/firefly-iii/firefly-iii/issues/7716) Removed bar in budget overview\n- [Issue 8251](https://github.com/firefly-iii/firefly-iii/issues/8251) Removing a budget would not remove available budget\n\n\n### API {#api_1}\n\n\n- [Issue 8022](https://github.com/firefly-iii/firefly-iii/issues/8022) API chart expansions\n- [Issue 8106](https://github.com/firefly-iii/firefly-iii/issues/8106) API reports empty string instead of NULL\n\n\n## 6.0.30 - 2023-10-29 {#6030-2023-10-29}\n\n\n\n### Fixed {#fixed_8}\n\n\n- Missing method after refactoring.\n\n\n## 6.0.29 - 2023-10-29 {#6029-2023-10-29}\n\n\n\n### Fixed {#fixed_9}\n\n\n- Null pointer in bill overview\n\n\n## 6.0.28 - 2023-10-29 {#6028-2023-10-29}\n\n\n\n### Added {#added_3}\n\n\n- [Issue 8076](https://github.com/firefly-iii/firefly-iii/issues/8076) Added a \"Clone and edit\"-button\n- [Issue 7204](https://github.com/firefly-iii/firefly-iii/issues/7204) Added the ability to customize the URL protocol types Firefly III accepts \n- [Issue 8098](https://github.com/firefly-iii/firefly-iii/issues/8098) More tests in the navigation class, thanks @tonicospinelli!\n\n\n### Changed {#changed_4}\n\n\n- Refactored the Actions of GitHub\n- The transaction currencies are now linked to users, and can be enabled per user\n- A few upgrade commands are refactored\n- You can no longer edit vital parts of reconciled transactions\n\n\n### Deprecated {#deprecated_1}\n\n\n- Remove old v3 layout.\n\n\n### Fixed {#fixed_10}\n\n\n- Bad math in the order of piggy banks\n- [Issue 8084](https://github.com/firefly-iii/firefly-iii/issues/8084) @JoSchrader fixed an issue with a duplicate button\n- [Issue 8103](https://github.com/firefly-iii/firefly-iii/issues/8103) Bulk edit would not accept transaction descriptions longer than 255 characters\n- [Issue 8099](https://github.com/firefly-iii/firefly-iii/issues/8099) The bill index would never skip the number of periods you indicated\n- [Issue 8069](https://github.com/firefly-iii/firefly-iii/issues/8069) Rule descriptions would always \"1\" as description. Thanks @Maxco10!\n\n\n### API {#api_2}\n\n\n- API will no longer accept changes to amount and account fields for reconciled transactions\n\n\n## v6.0.27 - 2023-10-16 {#v6027-2023-10-16}\n\n\n\n### Added {#added_4}\n\n\n- [Issue 8004](https://github.com/firefly-iii/firefly-iii/issues/8004) Warning in entrypoint script for missing variables.\n\n\n### Changed {#changed_5}\n\n\n- Experimental database validation command.\n- Add some values to the debug form.\n- Better debug logs at various places\n\n\n### Fixed {#fixed_11}\n\n\n- [Issue 8020](https://github.com/firefly-iii/firefly-iii/issues/8020), [issue 8028](https://github.com/firefly-iii/firefly-iii/issues/8028) Liability calculation edge case found by @tieu1991\n- [Issue 7655](https://github.com/firefly-iii/firefly-iii/issues/7655), [issue 8026](https://github.com/firefly-iii/firefly-iii/issues/8026) Bill date calculation edge case found by @devfaz\n- [Issue 8051](https://github.com/firefly-iii/firefly-iii/issues/8051) Null pointer when deleting account\n- [Issue 8041](https://github.com/firefly-iii/firefly-iii/issues/8041) Confusing chart is no longer confusing\n- [Issue 8050](https://github.com/firefly-iii/firefly-iii/issues/8050) Path is normal for page 2.\n- [Issue 8057](https://github.com/firefly-iii/firefly-iii/issues/8057) negative query parameters are handled correctly.\n\n\n### API (v2.0.10) {#api-v2010}\n\n\n- All endpoints (v1 and v2) should now respect the `?limit=` param.\n\n\n## 6.0.26 - 2023-09-24 {#6026-2023-09-24}\n\n\n\n### Fixed {#fixed_12}\n\n\n- [Issue 7986](https://github.com/firefly-iii/firefly-iii/issues/7986), [issue 7992](https://github.com/firefly-iii/firefly-iii/issues/7992) Fix exception when calling specific end points\n- [Issue 7990](https://github.com/firefly-iii/firefly-iii/issues/7990) Remove unused translations\n\n\n## 6.0.25 - 2023-09-24 {#6025-2023-09-24}\n\n\n\n### Changed {#changed_6}\n\n\n- v2 index has better overview of bills (now called subscriptions)\n\n\n### Deprecated {#deprecated_2}\n\n\n- My attempt to build the `v3`-layout is now officially deprecated and removed. To see the new layout (in beta), use `FIREFLY_III_LAYOUT=v2`.\n\n\n### Fixed {#fixed_13}\n\n\n- [Issue 7970](https://github.com/firefly-iii/firefly-iii/issues/7970) Bad redirect for mass edit/delete forms.\n- [Issue 7983](https://github.com/firefly-iii/firefly-iii/issues/7983) Bad math in the calculation of liabilities\n- [Issue 7973](https://github.com/firefly-iii/firefly-iii/issues/7973) Bad account validation broke certain imports\n- [Issue 7981](https://github.com/firefly-iii/firefly-iii/issues/7981) Menu had a bad link, thanks @Maxco10!\n- Slack alerts now use the correct URL\n- Better htaccess files thanks to Softaculous.\n\n\n### Security {#security_2}\n\n\n- Change htaccess rules so certain files can't be accessed.\n\n\n### API {#api_3}\n\n\n- [Issue 7972](https://github.com/firefly-iii/firefly-iii/issues/7972) The API needed start\n  *and* end parameters for transactions, this is no longer the case.\n- New APIs for user group and rights management. Not yet documented.\n\n\n## 6.0.24 - 2023-09-16 {#6024-2023-09-16}\n\n\n\n### Fixed {#fixed_14}\n\n\n- [Issue 7920](https://github.com/firefly-iii/firefly-iii/issues/7920) Issues with automatic budgets\n- [Issue 7940](https://github.com/firefly-iii/firefly-iii/issues/7940) Edge cases in the data import routine\n- [Issue 7963](https://github.com/firefly-iii/firefly-iii/issues/7963) Fix audit items for rules\n- Fixed all issues with relative URLs (which I caused myself)\n\n\n### API {#api_4}\n\n\n- [Issue 7944](https://github.com/firefly-iii/firefly-iii/issues/7944) Make sure all IDs are strings in the API\n\n\n## 6.0.23 - 2023-09-04 {#6023-2023-09-04}\n\n\n\n### Changed {#changed_7}\n\n\n- New debug information tables are in HTML\n\n\n### Fixed {#fixed_15}\n\n\n- Remove extra slashes from paths, breaking CSS\n\n\n## 6.0.22 - 2023-09-02 {#6022-2023-09-02}\n\n\n\n### API {#api_5}\n\n\n- [Issue 7917](https://github.com/firefly-iii/firefly-iii/issues/7917) Fixed an API issue where submitting an account name would not be accepted.\n\n\n## 6.0.21 - 2023-09-02 {#6021-2023-09-02}\n\n\n\n### Added {#added_5}\n\n\n- Rules will now report failures if a Slack/Discord notification channel is configured\n- Notifications can be sent to Discord\n- Beta layout `v2`, activate with `FIREFLY_III_LAYOUT=v2`\n\n\n### Changed {#changed_8}\n\n\n- Audit log settings are changed, refer to the `.env.example`-file.\n- Many URLs are new rendered as relative URLs.\n\n\n### Fixed {#fixed_16}\n\n\n- [Issue 7853](https://github.com/firefly-iii/firefly-iii/issues/7853) Left to spend on main page shows incorrect value\n- [Issue 7883](https://github.com/firefly-iii/firefly-iii/issues/7883) Missing translation\n- [Issue 7910](https://github.com/firefly-iii/firefly-iii/issues/7910) Type format error\n- Home page respects account order\n- JS errors for users using Firefly III in a subdir.\n\n\n### API {#api_6}\n\n\n- Bumped to v2.0.6 but only so the docs match again.\n\n\n## 6.0.20 - 2023-08-13 {#6020-2023-08-13}\n\n\n\n### Fixed {#fixed_17}\n\n\n- [Issue 7787](https://github.com/firefly-iii/firefly-iii/issues/7787) Possible issue when deleting multiple tags from a transaction.\n- [Issue 7792](https://github.com/firefly-iii/firefly-iii/issues/7792) Search for tags was broken in rules\n- [Issue 7803](https://github.com/firefly-iii/firefly-iii/issues/7803) @zqye fixed an issue where the cron job would fire when not necessary.\n- [Issue 7771](https://github.com/firefly-iii/firefly-iii/issues/7771) Unclear use of language in rule trigger\n- [Issue 7818](https://github.com/firefly-iii/firefly-iii/issues/7818) Amount was negative instead of positive.\n- [Issue 7810](https://github.com/firefly-iii/firefly-iii/issues/7810) Bad math\n- Asset accounts will correctly show transaction groups\n\n\n### API {#api_7}\n\n\n- Lots of new, undocumented v2 API endpoints.\n- [Issue 7845](https://github.com/firefly-iii/firefly-iii/issues/7845) Could not reconcile over API\n\n\n## 6.0.19 - 2023-07-29 {#6019-2023-07-29}\n\n\n\n### Fixed {#fixed_18}\n\n\n- [Issue 7577](https://github.com/firefly-iii/firefly-iii/issues/7577) Firefly III can't search for backward slashes in identifiers\n- [Issue 7762](https://github.com/firefly-iii/firefly-iii/issues/7762) User can't create access token\n\n\n## 6.0.18 - 2023-07-19 {#6018-2023-07-19}\n\n\n\n### Fixed {#fixed_19}\n\n\n- Slack messages would fail if not configured.\n- Bill display would include transactions from the previous period.\n- Debug information left in bill overview.\n- [Issue 7694](https://github.com/firefly-iii/firefly-iii/issues/7694) Missing CSS info in dark mode.\n- [Issue 7706](https://github.com/firefly-iii/firefly-iii/issues/7706) Deleting a budget would not reset the available amount.\n- [Issue 7749](https://github.com/firefly-iii/firefly-iii/issues/7749) Account overview would show just 1 transaction from a split of multiple.\n\n\n## 6.0.17 - 2023-07-16 {#6017-2023-07-16}\n\n\n\n### Added {#added_6}\n\n\n- New date calculation code and tests, thanks to @tonicospinelli!\n\n\n### Removed {#removed_2}\n\n\n- Heroku support\n\n\n### Fixed {#fixed_20}\n\n\n- [Issue 7704](https://github.com/firefly-iii/firefly-iii/issues/7704) Date issues with bills\n- Cache issue in budgets\n- Fixed the account validation for transfer transactions\n\n\n### API {#api_8}\n\n\n- Various fields would not accept `null` values\n\n\n## 6.0.16 - 2023-06-28 {#6016-2023-06-28}\n\n\n\n### Changed {#changed_9}\n\n\n- Better IBAN and account validation for new (API) transactions.\n\n\n### Fixed {#fixed_21}\n\n\n- Better transaction split validation in API.\n- [Issue 7683](https://github.com/firefly-iii/firefly-iii/issues/7683) Date validation in recurring transaction form.\n- [Issue 7686](https://github.com/firefly-iii/firefly-iii/issues/7686) Low contrast in dark mode, thanks @MateusBMP!\n- [Issue 7655](https://github.com/firefly-iii/firefly-iii/issues/7655) Bad date display in bills\n\n\n## 6.0.15 - 2023-06-22 {#6015-2023-06-22}\n\n\n\n### Fixed {#fixed_22}\n\n\n- [Issue 7678](https://github.com/firefly-iii/firefly-iii/issues/7678) Missing argument in postgres maintenance code\n  breaks startup.\n\n\n## 6.0.14 - 2023-06-22 {#6014-2023-06-22}\n\n\n\n### Added {#added_7}\n\n\n- Editing some fields will generate audit logs visible when you view a transaction. The number of fields monitored will\n  increase over time\n\n\n### Changed {#changed_10}\n\n\n- Account validation includes IBANs now, this helps the data importer\n- Unified and cleaned up all command line output\n\n\n### Fixed {#fixed_23}\n\n\n- [Issue 7630](https://github.com/firefly-iii/firefly-iii/issues/7630) Errors when upgrading using SQLite\n- [Issue 7642](https://github.com/firefly-iii/firefly-iii/issues/7642) nn_NO wasn't available for users\n- [Issue 7609](https://github.com/firefly-iii/firefly-iii/issues/7609), [issue 7659](https://github.com/firefly-iii/firefly-iii/issues/7659)\n  Rule execution form was broken\n- [Issue 7677](https://github.com/firefly-iii/firefly-iii/issues/7677) Amount was negative instead of positive in view\n- [Issue 7649](https://github.com/firefly-iii/firefly-iii/issues/7649) Bill edit screen would always suggest \"daily\"\n  repeat frequency\n- Nullpointer in bill repository class\n- Missing param in rule action, thanks @timendum!\n- Missing attachment overview in recurring transactions\n\n\n## v6.0.13 - 2023-06-12 {#v6013-2023-06-12}\n\n\n\n### Fixed {#fixed_24}\n\n\n- [Issue 7641](https://github.com/firefly-iii/firefly-iii/issues/7641) Crash with AUTHENTICATION_GUARD=web\n\n\n## v6.0.12 - 2023-06-12 {#v6012-2023-06-12}\n\n\n\n### Changed {#changed_11}\n\n\n- Command output and logo on the terminal improved.\n\n\n### Fixed {#fixed_25}\n\n\n- [Issue 7557](https://github.com/firefly-iii/firefly-iii/issues/7557) `firefly-iii:upgrade-database` step issue\n- [Issue 7572](https://github.com/firefly-iii/firefly-iii/issues/7572) Paid bill shown in wrong currency\n- [Issue 7593](https://github.com/firefly-iii/firefly-iii/issues/7593) Fix URLs in .env.example, thanks @josephbadow\n- [Issue 7620](https://github.com/firefly-iii/firefly-iii/issues/7620) Issues with light mode\n- [Issue 7618](https://github.com/firefly-iii/firefly-iii/issues/7618) Can't log out when using remote auth\n- [Issue 7613](https://github.com/firefly-iii/firefly-iii/issues/7613) Can't save piggy bank attachments\n\n\n### API {#api_9}\n\n\n- [Issue 7588](https://github.com/firefly-iii/firefly-iii/issues/7588) v1/recurrences not able to handle bills on\n  store & update\n- [Issue 7589](https://github.com/firefly-iii/firefly-iii/issues/7589) v1/recurrences fails when updating a split\n  transaction\n\n\n## v6.0.11 - 2023-05-28 {#v6011-2023-05-28}\n\n\n\n### Added {#added_8}\n\n\n- 🇰🇷 Korean translations!\n- A new \"adjusted\" auto-budget type that will correct itself after\n  spending. [Read more](https://docs.firefly-iii.org/firefly-iii/financial-concepts/organizing/#adjusted-and-correct-for-overspending)\n- [Issue 6631](https://github.com/firefly-iii/firefly-iii/issues/6631) Can now link withdrawals and deposits to piggy\n  banks, thanks @ChrisWin22!\n\n\n### Changed {#changed_12}\n\n\n- \"Balance\" is now called \"In + out this period\" so it's more clear what it means.\n\n\n### Removed {#removed_3}\n\n\n- Some superfluous logging.\n\n\n### Fixed {#fixed_26}\n\n\n- An intermittent issue came up where people would suffer from badly rounded numbers.\n  The root cause has been fixed. Open a discussion if this affects you, a fix for your data is available.\n- The API cron job would not run all available cron commands.\n- Debug page would always report midnight\n- [Issue 7514](https://github.com/firefly-iii/firefly-iii/issues/7514) DB error when upgrading to 6.0.10\n- [Issue 7516](https://github.com/firefly-iii/firefly-iii/issues/7516) Webhook: wrong JSON transaction amount\n- [Issue 7522](https://github.com/firefly-iii/firefly-iii/issues/7522) Time related events cause a timeout\n- [Issue 7541](https://github.com/firefly-iii/firefly-iii/issues/7541) Login screen display glitch\n- [Issue 7549](https://github.com/firefly-iii/firefly-iii/issues/7549) Account creation duplicate checking fails for\n  German umlaut\n- [Issue 7546](https://github.com/firefly-iii/firefly-iii/issues/7546) Version link doesn't work\n- [Issue 7547](https://github.com/firefly-iii/firefly-iii/issues/7547) Rule fails to convert \"Withdrawal from X to Y\"\n  to \"Transfer from Y to X\"\n\n\n### API {#api_10}\n\n\n- [Issue 7505](https://github.com/firefly-iii/firefly-iii/issues/7505) Several API schema dates have been fixed, thanks\n  @nagyv!\n\n\n## v6.0.10 - 2023-05-14 {#v6010-2023-05-14}\n\n\n\n### Added {#added_9}\n\n\n- The debug screen will also report on the build version of the BASE image.\n\n\n### Changed {#changed_13}\n\n\n- Health check will also check if the database is up.\n- [Issue 7461](https://github.com/firefly-iii/firefly-iii/issues/7461) MFA field will now autofocus, thanks @eandersons!\n\n\n### Removed {#removed_4}\n\n\n- IBAN check no longer triggers on empty IBANs\n\n\n### Fixed {#fixed_27}\n\n\n- Account validation when you only submit an IBAN.\n- [Issue 7478](https://github.com/firefly-iii/firefly-iii/issues/7478) [issue 7457](https://github.com/firefly-iii/firefly-iii/issues/7457)\n  Various fixes in budget limit and available amount management.\n- [Issue 7446](https://github.com/firefly-iii/firefly-iii/issues/7446) Bills \"Next expected match\" was incorrect\n- [Issue 7456](https://github.com/firefly-iii/firefly-iii/issues/7456) Missing date calculation fields.\n- [Issue 7448](https://github.com/firefly-iii/firefly-iii/issues/7448) [issue 7444](https://github.com/firefly-iii/firefly-iii/issues/7444)\n  Dark mode bad CSS\n\n\n## 6.0.9 - 2023-04-29 {#609-2023-04-29}\n\n\n\n### Added {#added_10}\n\n\n- Better length validation for text fields.\n\n\n### Changed {#changed_14}\n\n\n- Better calculation of available budget\n\n\n### Fixed {#fixed_28}\n\n\n- [Issue 7377](https://github.com/firefly-iii/firefly-iii/issues/7377) Tag search was broken\n- [Issue 7389](https://github.com/firefly-iii/firefly-iii/issues/7389) Bug in charts\n- [Issue 7394](https://github.com/firefly-iii/firefly-iii/issues/7394) unique iban check was broken\n- [Issue 7427](https://github.com/firefly-iii/firefly-iii/issues/7427) API would not accept page 18 and up.\n- [Issue 7410](https://github.com/firefly-iii/firefly-iii/issues/7410) Various dark mode color fixes\n- Old documentation links fixed by @mindlessroman and @noxonad!\n\n\n## 6.0.8 - 2023-04-16 {#608-2023-04-16}\n\n\n\n### Added {#added_11}\n\n\n- [Issue 7351](https://github.com/firefly-iii/firefly-iii/issues/7351) Optional command to force the decimal size.\n- [Issue 7352](https://github.com/firefly-iii/firefly-iii/issues/7352) Optional command to force the migrations.\n- [Issue 7354](https://github.com/firefly-iii/firefly-iii/issues/7354) The new v3 layout will redirect to the index when\n  unauthenticated, thanks @corcom!\n\n\n### Fixed {#fixed_29}\n\n\n- [Issue 7349](https://github.com/firefly-iii/firefly-iii/issues/7349) Missing tables in PostgreSQL script.\n- [Issue 7358](https://github.com/firefly-iii/firefly-iii/issues/7358) Could not create liabilities with a pre-set\n  amount.\n- Fix date field in bill warning mail.\n- Fix installer script.\n- Remove attachment paperclip from transactions with deleted attachments.\n\n\n### API {#api_11}\n\n\n- [Issue 7347](https://github.com/firefly-iii/firefly-iii/issues/7347) API made rules would be inactive by default.\n\n\n## v6.0.7 - 2023-04-09 {#v607-2023-04-09}\n\n\n\n### Added {#added_12}\n\n\n- Lots of error catching in DB migrations for smoother upgrades.\n- New command `firefly-iii:force-migration` which will force database migrations to run. It will probably also destroy\n  your database so don't use it.\n- You can now force light/dark mode in your settings.\n\n\n### Fixed {#fixed_30}\n\n\n- [Issue 7137](https://github.com/firefly-iii/firefly-iii/issues/7137) Inconsistent rule test form\n- [Issue 7320](https://github.com/firefly-iii/firefly-iii/issues/7320) Standard email values so less errors\n- [Issue 7311](https://github.com/firefly-iii/firefly-iii/issues/7311) Fix issue with date validation\n- [Issue 7310](https://github.com/firefly-iii/firefly-iii/issues/7310) Better color contrast in dark mode.\n\n\n### API {#api_12}\n\n\n- [Issue 7308](https://github.com/firefly-iii/firefly-iii/issues/7308) Could not set current amount for certain piggy\n  banks\n\n\n## v6.0.6 - 2023-04-02 {#v606-2023-04-02}\n\n\n\n### Changed {#changed_15}\n\n\n- Database migrations are capped at 12 decimals.\n- Currency processing is capped at 12 decimals.\n- Mail errors no longer crash the app but report the error in logs\n- Disabled Sonarcloud runs\n\n\n### Fixed {#fixed_31}\n\n\n- \"Change transaction type\"-rule actions would create a new expense account instead of finding a liability.\n- New users from remote user repositories would not be able to create new asset accounts.\n- Firefly III would create \"Loan\" instead of \"Expense account\" when faced with unknown accounts during API calls.\n- Icons would not show up in the minimized left-hand menu.\n- Contrast for dark mode improved.\n- Better credit calculation for liabilities in case of complex transactions.\n\n\n### API {#api_13}\n\n\n- Fixed: Could not give piggy bank an unlimited amount.\n- [Issue 7335](https://github.com/firefly-iii/firefly-iii/issues/7335) Fix upload of attachments, thanks @fengkaijia\n\n\n## v6.0.5 - 2023-03-19 {#v605-2023-03-19}\n\n\n\n### Changed {#changed_16}\n\n\n- Mathematical accuracy is set to 12 decimals. This is accurate enough for most currencies and prevents rounding issues\n  for systems that don't support more.\n\n\n### Fixed {#fixed_32}\n\n\n- [Issue 7227](https://github.com/firefly-iii/firefly-iii/issues/7227) Could not set webhooks to the correct trigger.\n- [Issue 7221](https://github.com/firefly-iii/firefly-iii/issues/7221) Could not see the result of a rule test.\n\n\n## v6.0.4 - 2023-03-13 {#v604-2023-03-13}\n\n\n\n### Fixed {#fixed_33}\n\n\n- [Issue 7214](https://github.com/firefly-iii/firefly-iii/issues/7214) Import issue blocking multi currency transactions\n\n\n## v6.0.3 - 2023-03-13 {#v603-2023-03-13}\n\n\n\n### Fixed {#fixed_34}\n\n\n- [Issue 7201](https://github.com/firefly-iii/firefly-iii/issues/7201) Security-related console automatically command\n  runs before a database is set, and may error out.\n\n\n## v6.0.2 - 2023-03-11 {#v602-2023-03-11}\n\n\n\n### Fixed {#fixed_35}\n\n\n- [Issue 7186](https://github.com/firefly-iii/firefly-iii/issues/7186) Fix broken date range\n- [Issue 7188](https://github.com/firefly-iii/firefly-iii/issues/7188) Fix broken search\n- [Issue 7189](https://github.com/firefly-iii/firefly-iii/issues/7189) Too strict account validation\n- [Issue 7142](https://github.com/firefly-iii/firefly-iii/issues/7142) Better contrast in dark mode\n\n\n## 6.0.1 - 2023-03-11 {#601-2023-03-11}\n\n\n\n### Changed {#changed_17}\n\n\n- [Issue 7129](https://github.com/firefly-iii/firefly-iii/issues/7129) Catch common email errors as log errors.\n\n\n### Fixed {#fixed_36}\n\n\n- [Issue 7109](https://github.com/firefly-iii/firefly-iii/issues/7109) Fix CSS in subdirectories, thanks @GaneshKandu\n- [Issue 7112](https://github.com/firefly-iii/firefly-iii/issues/7112) Version number parsing\n- [Issue 6985](https://github.com/firefly-iii/firefly-iii/issues/6985) Mandrill mail support\n- [Issue 7131](https://github.com/firefly-iii/firefly-iii/issues/7131) Fix account sorting, thanks @lflare\n- [Issue 7130](https://github.com/firefly-iii/firefly-iii/issues/7130) Fix missing date range parsers\n- [Issue 7156](https://github.com/firefly-iii/firefly-iii/issues/7156) Default values for email settings break tokens\n- [Issue 7140](https://github.com/firefly-iii/firefly-iii/issues/7140) Header with charset would break API validation\n- [Issue 7144](https://github.com/firefly-iii/firefly-iii/issues/7144) Debug page could not handle missing log files\n- [Issue 7159](https://github.com/firefly-iii/firefly-iii/issues/7159) Bad parsing in success messages\n- [Issue 7104](https://github.com/firefly-iii/firefly-iii/issues/7104) Missing colors in dark mode\n- [Issue 7120](https://github.com/firefly-iii/firefly-iii/issues/7120) Missing borders in dark mode\n- [Issue 7156](https://github.com/firefly-iii/firefly-iii/issues/7156) Bad HTML parsing in transaction form\n- [Issue 7166](https://github.com/firefly-iii/firefly-iii/issues/7166) Rule trigger would trigger on the wrong\n  transaction set\n- [Issue 7112](https://github.com/firefly-iii/firefly-iii/issues/7112) Content filter would strip emojis\n- [Issue 7175](https://github.com/firefly-iii/firefly-iii/issues/7175) Could not delete user invite\n- [Issue 7177](https://github.com/firefly-iii/firefly-iii/issues/7177) Missing currency info would break cron job\n\n\n### API {#api_14}\n\n\n- [Issue 7127](https://github.com/firefly-iii/firefly-iii/issues/7127) Expand API with new option for \"destroy\" button.\n- [Issue 7124](https://github.com/firefly-iii/firefly-iii/issues/7124) API would not break on missing foreign currency\n  information\n\n\n\n## 6.0.0 - 2023-03-03 {#600-2023-03-03}\n\n\n\n### Warnings {#warnings}\n\n\n- The upgrade is not backwards compatible for people who manage outgoing loans (money borrowed to other people). Transactions will be removed or changed. See [this Gist](https://gist.github.com/JC5/909385c5086f9e07ba2c32e047446d68) for more information.\n- You will need to make a backup of your database.\n- You must use PHP 8.2 or use the Docker container.\n\n\n### Notes {#notes}\n\n\n- The new **v3** layout is not yet finished, and it should **not** be used to edit or add data.\n\n\n### Added {#added_13}\n- Introduce Jetbrains Qodana code scanning for code quality.\n- Reintroduced PHPUnit tests\n- Added a warning for people using the \"remote user guard\" in combination with Personal Access Tokens.\n- Improved validation across the board.\n- First code to validate a user's financial administration\n- Dark mode CSS\n- New language: Catalan\n- \"Working\" beta of the new layout under `/v3/`\n- There is a page for webhooks.\n- [Issue 4975](https://github.com/firefly-iii/firefly-iii/issues/4975) Rules can copy/move description to notes and vice versa\n- [Issue 5031](https://github.com/firefly-iii/firefly-iii/issues/5031) You can invite users to your installation when registration is off\n- [Issue 5213](https://github.com/firefly-iii/firefly-iii/issues/5213) You can trigger recurring transactions beforehand\n- [Issue 5592](https://github.com/firefly-iii/firefly-iii/issues/5592) Transactions have a little history box to show how rules changed them\n- [Issue 5752](https://github.com/firefly-iii/firefly-iii/issues/5752) Firefly III can send Slack notifications instead of emails\n- [Issue 5862](https://github.com/firefly-iii/firefly-iii/issues/5862) Search can filter on reconciled transactions\n- [Issue 6086](https://github.com/firefly-iii/firefly-iii/issues/6086) All search filters can be negative by putting `-` in front of them\n- [Issue 6441](https://github.com/firefly-iii/firefly-iii/issues/6441) Buttons to purge deleted data, which is easy for data imports\n- [Issue 6457](https://github.com/firefly-iii/firefly-iii/issues/6457) Rule trigger 'transaction exists', that will always trigger\n- [Issue 6526](https://github.com/firefly-iii/firefly-iii/issues/6526) Option to disable rules and/or webhooks when saving transactions\n- [Issue 6605](https://github.com/firefly-iii/firefly-iii/issues/6605) You can search for external ID values\n\n\n### Changed {#changed_18}\n- Completely rewritten documentation at https://docs.firefly-iii.org\n- Bad escape in JS code has been fixed.\n- Added date validation in routes for better script kiddie protection\n- Shorter titles in object groups\n- Piggy bank actions are created correctly\n- Some bad spelling in a header check\n- Various errors no longer throw a 500 but a 422 (validation failed)\n- The translations now have a warning in the comments so people don't submit translations.\n- [Issue 6824](https://github.com/firefly-iii/firefly-iii/issues/6824) Fix issue with bills.\n- [Issue 6828](https://github.com/firefly-iii/firefly-iii/issues/6828) Catch bad number in API\n- [Issue 6829](https://github.com/firefly-iii/firefly-iii/issues/6829) Better error catching in API\n- [Issue 6831](https://github.com/firefly-iii/firefly-iii/issues/6831) TypeError when using remote authentication\n- [Issue 6834](https://github.com/firefly-iii/firefly-iii/issues/6834) Will use IBAN in account names if account exists already with a different IBAN\n- [Issue 6842](https://github.com/firefly-iii/firefly-iii/issues/6842) Switch from expense to revenue when importing data.\n- [Issue 6855](https://github.com/firefly-iii/firefly-iii/issues/6855) Do not validate currency if currency is NULL, thanks @eps90!\n- [Issue 6869](https://github.com/firefly-iii/firefly-iii/issues/6869) Liability created via API is not applying opening balance.\n- [Issue 6870](https://github.com/firefly-iii/firefly-iii/issues/6870) Old inactive recurring transactions do not lose categories when the categories are deleted\n- [Issue 6974](https://github.com/firefly-iii/firefly-iii/issues/6974) Auto budget amount fix.\n- [Issue 6876](https://github.com/firefly-iii/firefly-iii/issues/6876) Date field is validated in recurring transactions\n- [Issue 6581](https://github.com/firefly-iii/firefly-iii/issues/6581) Fields were not cleared in the transaction screen in some cases\n\n\n### Removed {#removed_5}\n- [Issue 4198](https://github.com/firefly-iii/firefly-iii/issues/4198) The total available budget amount bar on the `/budgets` page is no longer manageable but will be auto-calculated\n- Cryptocurrencies in default currency set\n- Unused environment variables\n\n\n### API {#api_15}\n- URLs with underscores in them have been updated to use dashes instead (`piggy_banks` -> `piggy-banks`).\n- [Issue 6130](https://github.com/firefly-iii/firefly-iii/issues/6130) You can now create a reconciliation transaction\n- New `v2` endpoints, see new documentation at https://api-docs.firefly-iii.org\n- Various API fixes\n\n\n### Security {#security_3}\n- [Issue 6826](https://github.com/firefly-iii/firefly-iii/issues/6826) Hide 2FA information when printing, thanks @jstebenne!\n- Blocked users can access API, and users can unblock themselves using the API. This was reported in CVE-2023-0298.\n- Several other low-key fixes.\n\n\n\n## 5.7.18 - 2023-01-03 {#5718-2023-01-03}\n\n\n\n### Fixed {#fixed_37}\n- [Issue 6775](https://github.com/firefly-iii/firefly-iii/issues/6775) OAuth authentication was broken for Authelia and other remote user providers.\n- [Issue 6787](https://github.com/firefly-iii/firefly-iii/issues/6787) SQLite value conversion broke several functions\n\n\n## 5.7.17 - 2022-12-30 {#5717-2022-12-30}\n\n\n\n### Fixed {#fixed_38}\n- [Issue 6742](https://github.com/firefly-iii/firefly-iii/issues/6742) Error when a rule tries to add or remove an amount from a piggy bank\n- [Issue 6743](https://github.com/firefly-iii/firefly-iii/issues/6743) Error when opening piggy bank overview\n- [Issue 6753](https://github.com/firefly-iii/firefly-iii/issues/6753) Rules are not finding any transactions with trigger 'Amount is greater than 0'\n\n\n## 5.7.16 - 2022-12-25 {#5716-2022-12-25}\n\n\n\n### Added {#added_14}\n- You can now search for SEPA CT, thanks @dasJ!\n\n\n### Changed {#changed_19}\n- Links go to [Mastodon](https://fosstodon.org/@ff3), not Twitter.\n- Most if not all remaining float values removed. None were used in financial math.\n- Expand Laravel Passport settings.\n\n\n### Fixed {#fixed_39}\n- [Issue 6597](https://github.com/firefly-iii/firefly-iii/issues/6597) Edit existing split transaction's source did not work properly.\n- [Issue 6610](https://github.com/firefly-iii/firefly-iii/issues/6610) Fix search for attachments\n- [Issue 6625](https://github.com/firefly-iii/firefly-iii/issues/6625) Page of the links is not displayed due to an error\n- [Issue 6701](https://github.com/firefly-iii/firefly-iii/issues/6701) Ensure remote_guard_alt_email if changed, thanks @nebulade!\n- Remove some null pointers in the code.\n- Add missing locale data\n- Fixed typo, thx @charlesteets!\n- Various issues with piggy banks\n- Clear cache after a transaction is deleted.\n- Be more clear about registrations being disabled.\n\n\n### Security {#security_4}\n- Updated all packages and dependencies.\n\n\n### API {#api_16}\n- Fix API endpoint that would not accept two of the same dates.\n\n\n## 5.7.15 - 2022-11-02 {#5715-2022-11-02}\n\n\n\n### Fixed {#fixed_40}\n- You can no longer set the currency of expense and revenue accounts.\n- Form elements are not spell checked anymore (privacy).\n- [Issue 6556](https://github.com/firefly-iii/firefly-iii/issues/6556) Wrong value used in bill chart\n- [Issue 6564](https://github.com/firefly-iii/firefly-iii/issues/6564) Right-Align numbers to match monetary value digits\n- [Issue 6589](https://github.com/firefly-iii/firefly-iii/issues/6589) Webhook not fired after destroying transaction\n- Add missing locale data\n\n\n\n## 5.7.14 - 2022-10-19 {#5714-2022-10-19}\n\n\n\n### Fixed {#fixed_41}\n- Bulk editing transactions works.\n- Negative budgets no longer work.\n\n\n## 5.7.13 - 2022-10-17 {#5713-2022-10-17}\n\n\n\n### Added {#added_15}\n- [Issue 6502](https://github.com/firefly-iii/firefly-iii/issues/6502) A few students from @D7032E-Group-6 added MTD and YTD, thanks!\n\n\n### Fixed {#fixed_42}\n- [Issue 6461](https://github.com/firefly-iii/firefly-iii/issues/6461) Broken link in `/public` directory warning.\n- [Issue 6475](https://github.com/firefly-iii/firefly-iii/issues/6475) Method name mixup.\n- [Issue 6471](https://github.com/firefly-iii/firefly-iii/issues/6471) Fix float conversion\n- [Issue 6510](https://github.com/firefly-iii/firefly-iii/issues/6510) Destroy transaction now also triggers liability recalculation.\n- Amount check for budget amounts was too low.\n- Some other small fixes\n\n\n### API {#api_17}\n- [Issue 6481](https://github.com/firefly-iii/firefly-iii/issues/6481) Mixup in API validation, fixed by @janw\n\n\n## 5.7.12 - 2022-09-12 {#5712-2022-09-12}\n\n\n\n### Fixed {#fixed_43}\n- [Issue 6287](https://github.com/firefly-iii/firefly-iii/issues/6287) Catch error when trying to email with invalid settings.\n- [Issue 6423](https://github.com/firefly-iii/firefly-iii/issues/6423) Fix redis error, thanks @canoine!\n- [Issue 6421](https://github.com/firefly-iii/firefly-iii/issues/6421) Fix issue with SQLite.\n- [Issue 6379](https://github.com/firefly-iii/firefly-iii/issues/6379) Fix issue when user has lots of currencies but short list settings.\n- [Issue 6333](https://github.com/firefly-iii/firefly-iii/issues/6333) Fix broken chart for reconciliation.\n- [Issue 6332](https://github.com/firefly-iii/firefly-iii/issues/6332) Fix issue with uploading zipped PDF's.\n\n\n## 5.7.11 - 2022-09-05 {#5711-2022-09-05}\n\n\n\n### Added {#added_16}\n- [Issue 6254](https://github.com/firefly-iii/firefly-iii/issues/6254) Use Piggy Bank's start date in monthly suggestion by @rickdoesdev\n- Add best practices badge.\n- Various sanity checks on large amounts.\n\n\n### Removed {#removed_6}\n- Service worker is removed.\n\n\n### Fixed {#fixed_44}\n- [Issue 6260](https://github.com/firefly-iii/firefly-iii/issues/6260)\n- [Issue 6271](https://github.com/firefly-iii/firefly-iii/issues/6271) Improve settings for Redis, by @canoine\n- [Issue 6283](https://github.com/firefly-iii/firefly-iii/issues/6283) Convert to deposit means the transaction loses its bill.\n- Fix issue with foreign currencies in transaction form.\n- Fix various issues with SQLite.\n- [Issue 6379](https://github.com/firefly-iii/firefly-iii/issues/6379) Some foreign currencies not list for setting on new transactions\n- Make 2FA code + validation more robust. Thanks to @jtmoss3991, @timaschew and @Ottega.\n\n\n## 5.7.10 - 2022-07-16 {#5710-2022-07-16}\n\n\n\n### Fixed {#fixed_45}\n- [Issue 6122](https://github.com/firefly-iii/firefly-iii/issues/6122) Type error on data import and display\n- SQLite query issues fixed\n- Fix nullpointer.\n- [Issue 6168](https://github.com/firefly-iii/firefly-iii/issues/6168) Missing date overview in no-category list.\n- [Issue 6165](https://github.com/firefly-iii/firefly-iii/issues/6165) Account numbers could not be shared between expense and revenue accounts.\n- [Issue 6150](https://github.com/firefly-iii/firefly-iii/issues/6150) The first remote user would not get admin.\n- [Issue 6118](https://github.com/firefly-iii/firefly-iii/issues/6118) Piggy bank events would not get copied when transaction was copied.\n\n\n### Security {#security_5}\n- Update packages\n\n\n## 5.7.9 - 2022-06-01 {#579-2022-06-01}\n\n\n\n### Fixed {#fixed_46}\n- Symfony 6.1 requires PHP 8.1, so back to 6.0 for the time being.\n\n\n## 5.7.8 - 2022-06-01 {#578-2022-06-01}\n\n\n\n### Fixed {#fixed_47}\n- Symfony 6.1 requires PHP 8.1, so back to 6.0 for the time being.\n\n\n## 5.7.7 - 2022-06-01 {#577-2022-06-01}\n\n\n\n### Fixed {#fixed_48}\n- Fixed an issue where the login form would overflow a database field.\n- [Issue 6113](https://github.com/firefly-iii/firefly-iii/issues/6113) Fix issue with number formatting.\n- [Issue 5996](https://github.com/firefly-iii/firefly-iii/issues/5996) Catch bad library\n\n\n### Added {#added_17}\n- @turrisxyz added a dependency review, thanks!\n\n\n## 5.7.6 - 2022-05-19 {#576-2022-05-19}\n\n\n\n### Fixed {#fixed_49}\n- [Issue 6058](https://github.com/firefly-iii/firefly-iii/issues/6058) Bad type-casting could break Firefly III on Home Assistant.\n- [Issue 6059](https://github.com/firefly-iii/firefly-iii/issues/6059) Fix issue with missing list of bills when creating a recurring transaction from a transaction.\n- Added missing DB integrity checks.\n\n\n### Security {#security_6}\n- Updated various packages\n\n\n## 5.7.5 - 2022-05-06 {#575-2022-05-06}\n\n\n\n### Fixed {#fixed_50}\n- Fixed an issue where missing method names would break the API.\n- [Issue 6040](https://github.com/firefly-iii/firefly-iii/issues/6040) Could not add or remove money from piggy banks without a target.\n- [Issue 6009](https://github.com/firefly-iii/firefly-iii/issues/6009) `has_no_attachments:true` would not return transactions with *deleted* transactions.\n- [Issue 6050](https://github.com/firefly-iii/firefly-iii/issues/6050) ja_JP is part of the Docker image\n\n\n## 5.7.4 - 2022-05-03 {#574-2022-05-03}\n\n\n\n### Fixed {#fixed_51}\n- Fixed issue in method names.\n\n\n## 5.7.3 - 2022-05-03 {#573-2022-05-03}\n\n\n\n### Fixed {#fixed_52}\n- Searching for `updated_at_before` and `created_at_before` works again.\n- [Issue 6000](https://github.com/firefly-iii/firefly-iii/issues/6000) Bad math when dealing with multi-currency reconciliation.\n- Remove unused CSS\n- Fix bad migration.\n\n\n### API {#api_18}\n- Add error code to error message.\n\n\n## 5.7.2 - 2022-04-13 {#572-2022-04-13}\n\n\n\n### Fixed {#fixed_53}\n- Not configuring email would break registration.\n- Extra validation on piggy bank amounts.\n\n\n## 5.7.1 - 2022-04-05 {#571-2022-04-05}\n\n\n\n### Fixed {#fixed_54}\n- Fixes an issue with showing piggy banks\n- [Issue 5961](https://github.com/firefly-iii/firefly-iii/issues/5961) Fixes an issue registering new users\n\n\n## 5.7.0 - 2022-04-04 {#570-2022-04-04}\n\n\n- ⚠️ This release no longer supports LDAP.\n- ⚠️ This is the last release that supports PHP 8.0\n- 👍 Want to try the new v3 layout? At your own risk, browse to `/v3/`.\n\nPlease refer to the [documentation](https://docs.firefly-iii.org/firefly-iii/) and support channels if you run into problems:\n\n- [Gitter.im](https://gitter.im/firefly-iii/firefly-iii)\n- [Twitter](https://twitter.com/Firefly_III/)\n- [GitHub Issues](https://github.com/firefly-iii/firefly-iii/issues)\n- [GitHub Discussions](https://github.com/firefly-iii/firefly-iii/discussions)\n\n\n### Added {#added_18}\n- Error email message now includes HTTP headers.\n- [Issue 5373](https://github.com/firefly-iii/firefly-iii/issues/5373) You can give budgets notes, although they're not visible yet.\n- [Issue 5648](https://github.com/firefly-iii/firefly-iii/issues/5648) The Docker image supports custom locales, see `.env.example` for instructions.\n- [Issue 3984](https://github.com/firefly-iii/firefly-iii/issues/3984) [issue 5636](https://github.com/firefly-iii/firefly-iii/issues/5636) [issue 4903](https://github.com/firefly-iii/firefly-iii/issues/4903) [issue 5326](https://github.com/firefly-iii/firefly-iii/issues/5326) Lots of new search and rule operators. For the full list, see [search.php](https://github.com/firefly-iii/firefly-iii/blob/main/config/search.php) (a bit technical).\n- [Issue 5269](https://github.com/firefly-iii/firefly-iii/issues/5269) It's possible to add piggy banks that have no explicit target amount goal.\n- [Issue 4893](https://github.com/firefly-iii/firefly-iii/issues/4893) Bills can be given an end date and an extension date and will warn you about those dates.\n\n\n### Changed {#changed_20}\n- [Issue 5757](https://github.com/firefly-iii/firefly-iii/issues/5757) Upgrade to Laravel 9.\n\n\n### Deprecated {#deprecated_3}\n- [Issue 5911](https://github.com/firefly-iii/firefly-iii/issues/5911) Removed support for LDAP.\n\n\n### Fixed {#fixed_55}\n- [Issue 5810](https://github.com/firefly-iii/firefly-iii/issues/5810) Could not search for `no_notes:true` in some cases.\n- [Issue 5869](https://github.com/firefly-iii/firefly-iii/issues/5869) Converting transactions would sometimes fail.\n- [Issue 5870](https://github.com/firefly-iii/firefly-iii/issues/5870) Fixed broken link to instructions.\n- [Issue 5903](https://github.com/firefly-iii/firefly-iii/issues/5903) API budget limits was broken due to upgraded package.\n- [Issue 5852](https://github.com/firefly-iii/firefly-iii/issues/5852) It was not possible to recreate a currency.\n- [Issue 5882](https://github.com/firefly-iii/firefly-iii/issues/5882) `no_external_url:true` was broken.\n- [Issue 5770](https://github.com/firefly-iii/firefly-iii/issues/5770) Liabilities spent amount would be doubled.\n- [Issue 4013](https://github.com/firefly-iii/firefly-iii/issues/4013) Date in email message was not localized.\n- [Issue 5949](https://github.com/firefly-iii/firefly-iii/issues/5949) Deleting a transaction would sometimes send you back to a 404.\n\n\n## 5.6.16 - 2022-03-01 {#5616-2022-03-01}\n\n\n\n### Fixed {#fixed_56}\n- Broken migration would clash during startup.\n\n\n## 5.6.15 - 2022-03-01 {#5615-2022-03-01}\n\n\n\n### Changed {#changed_21}\n- Meta field `external_uri` will be renamed properly.\n- Migrations are more robust.\n\n\n### Fixed {#fixed_57}\n- [Issue 5493](https://github.com/firefly-iii/firefly-iii/issues/5493) CSP is too strict in some cases\n- [Issue 5694](https://github.com/firefly-iii/firefly-iii/issues/5694) Adding attachment on some expenses causes them to disappear from transactions list\n- [Issue 5724](https://github.com/firefly-iii/firefly-iii/issues/5724) Filter `no_external_url` fixed.\n- [Issue 5806](https://github.com/firefly-iii/firefly-iii/issues/5806) Pagination on \"all transactions without budget\" was broken\n- [Issue 5810](https://github.com/firefly-iii/firefly-iii/issues/5810) Search query with `no_notes:true` breaks after editing transaction\n\n\n### API {#api_19}\n- Expanded the number of config fields you can pick up.\n- Rules also validate the number of active triggers or actions.\n\n\n## 5.6.14 - 2022-02-06 {#5614-2022-02-06}\n\n\n\n### Added {#added_19}\n- Can now add daily bills\n\n\n### Removed {#removed_7}\n- Code related to the dynamic help text on GitHub\n\n\n### Fixed {#fixed_58}\n- [Issue 5664](https://github.com/firefly-iii/firefly-iii/issues/5664) Bad report dates\n- [Issue 5666](https://github.com/firefly-iii/firefly-iii/issues/5666) Unexpected parse issue.\n- [Issue 5695](https://github.com/firefly-iii/firefly-iii/issues/5695) Search would miss the 26th account in a wildcard search.\n- Install template was not working, thanks Softaculous!\n- Empty string in reports URL could lead to parse issues.\n\n\n### API {#api_20}\n- [Issue 5661](https://github.com/firefly-iii/firefly-iii/issues/5661) Various fields could not be set to NULL\n- [Issue 5670](https://github.com/firefly-iii/firefly-iii/issues/5670) Better date validation for rules\n- Various YAML updates to better reflect the API.\n\n\n## 5.6.13 - 2022-01-29 {#5613-2022-01-29}\n\n\n\n### Fixed {#fixed_59}\n- Fixed a few broken template references.\n\n\n## 5.6.12 - 2022-01-29 {#5612-2022-01-29}\n\n\n\n### Fixed {#fixed_60}\n- Fixed a few broken template references.\n\n\n## 5.6.11 - 2022-01-28 {#5611-2022-01-28}\n\n\n\n### Added {#added_20}\n- Added various debug log entries to diagnose issues\n- Add various validation rules to the report page\n- Created a new search option and rule trigger for the `external_url`-field, thanks @GeorgeHahn!\n- Extra support for the `DB_SOCKET` configuration value in various places\n\n\n### Fixed {#fixed_61}\n- [Issue 5422](https://github.com/firefly-iii/firefly-iii/issues/5422) Updating a liability account fails when passing in opening balance and opening balance date via API\n- [Issue 5540](https://github.com/firefly-iii/firefly-iii/issues/5540) Move rules using the API\n- [Issue 5575](https://github.com/firefly-iii/firefly-iii/issues/5575) Reconciling with a non-real date makes the reconciliation screen fail to load\n- [Issue 5610](https://github.com/firefly-iii/firefly-iii/issues/5610) Updating transaction with invalid splits fixed\n\n\n### API {#api_21}\n- [Issue 5540](https://github.com/firefly-iii/firefly-iii/issues/5540) Move rules using the API\n- [Issue 5610](https://github.com/firefly-iii/firefly-iii/issues/5610) Updating transaction with invalid splits fixed\n- Add missing field, external_url\n- Various fixes in transaction PUT endpoint.\n\n\n## 5.6.10 - 2022-01-10 {#5610-2022-01-10}\n\n\n\n### Added {#added_21}\n- Add currency MXN\n- [Issue 5503](https://github.com/firefly-iii/firefly-iii/issues/5503) option to set PostgreSQL schema.\n\n\n### Changed {#changed_22}\n- All IBANs will get their spaces stripped, but displayed with spaces.\n\n\n### Removed {#removed_8}\n- Remove confirmation popup from rule selection.\n- Remove some debug logging\n\n\n### Fixed {#fixed_62}\n- Empty opening balance won't show as \"0.00\"\n- Display of build and date had a newline.\n- Nullpointer in account validator\n- [Issue 5510](https://github.com/firefly-iii/firefly-iii/issues/5510) Fix bad translation\n\n\n## 5.6.9 - 2022-01-02 {#569-2022-01-02}\n\n\n\n### Added {#added_22}\n- Debug form has the build number and date, if available.\n\n\n### Deprecated {#deprecated_4}\n- The \"v2\" layout comes with a warning.\n\n\n### Fixed {#fixed_63}\n- Public/private key pair restore had some edge cases.\n- [Issue 5464](https://github.com/firefly-iii/firefly-iii/issues/5464) Backwards incompatible change in minor upgrade of Twigbridge broke breadcrumbs.\n- Overlapping `date()` function would crash Firefly III\n- [Issue 5458](https://github.com/firefly-iii/firefly-iii/issues/5458) Firefly III would create an opposing account of the wrong type.\n- [Issue 5467](https://github.com/firefly-iii/firefly-iii/issues/5467) Disabling currencies did not report properly.\n\n\n## 5.6.8 - 2021-12-19 {#568-2021-12-19}\n\n\n\n### Fixed {#fixed_64}\n- Account validation was broken in some edge cases, making it impossible to edit transactions.\n\n\n## 5.6.7 - 2021-12-19 {#567-2021-12-19}\n\n\n\n### Changed {#changed_23}\n- Rewrote part of the transaction engine to improve account search.\n\n\n### Fixed {#fixed_65}\n- Rule engine could not deal with dates in some edge cases, thanks @daften for the inspiration!\n- Several annoying layout v2 issues fixed.\n\n\n## 5.6.6 - 2021-12-10 {#566-2021-12-10}\n\n\n\n### Fixed {#fixed_66}\n- Cache is flushed after API action to delete a transaction.\n- Stricter validation of OAuth key existence.\n- [Issue 5371](https://github.com/firefly-iii/firefly-iii/issues/5371), thanks to @weimdall fixes budget issue.\n- Various v2 layout issues fixed: [issue 5375](https://github.com/firefly-iii/firefly-iii/issues/5375) [issue 5279](https://github.com/firefly-iii/firefly-iii/issues/5279) [issue 5108](https://github.com/firefly-iii/firefly-iii/issues/5108) [issue 5352](https://github.com/firefly-iii/firefly-iii/issues/5352) [issue 5335](https://github.com/firefly-iii/firefly-iii/issues/5335) [issue 5327](https://github.com/firefly-iii/firefly-iii/issues/5327) [issue 5296](https://github.com/firefly-iii/firefly-iii/issues/5296), thanks for reporting!\n\n\n### API {#api_22}\n- Add field `has_attachments` to transaction splits\n\n\n### Security {#security_7}\n- CSRF issue found by the good people of huntr.dev (@418sec)\n\n\n## 5.6.5 - 2021-11-25 {#565-2021-11-25}\n\n\n\n### Fixed {#fixed_67}\n- [Issue 5231](https://github.com/firefly-iii/firefly-iii/issues/5231) Various LDAP related fixes which I hope will allow you to use LDAP again.\n- [Issue 5288](https://github.com/firefly-iii/firefly-iii/issues/5288) Would generate new keys when not necessary.\n- [Issue 5245](https://github.com/firefly-iii/firefly-iii/issues/5245) Fix various weirdly formatted amounts.\n- [Issue 5240](https://github.com/firefly-iii/firefly-iii/issues/5240) Redirect issue when setting budget amounts.\n- [Issue 5325](https://github.com/firefly-iii/firefly-iii/issues/5325) Opening balance was always positive.\n\n\n### Security {#security_8}\n- Various minor CSRF\n\n\n## 5.6.4 - 2021-11-13 {#564-2021-11-13}\n\n\n\n### Fixed {#fixed_68}\n- [Issue 5276](https://github.com/firefly-iii/firefly-iii/issues/5276) Sloppy release, this fixes an issue with logging out.\n\n\n## 5.6.3 - 2021-11-12 {#563-2021-11-12}\n\n\n\n### Changed {#changed_24}\n- [Issue 5133](https://github.com/firefly-iii/firefly-iii/issues/5133) Several possible fixes for LDAP filter.\n\n\n### Fixed {#fixed_69}\n- [Issue 5116](https://github.com/firefly-iii/firefly-iii/issues/5116) Fix missing icon\n- [Issue 5173](https://github.com/firefly-iii/firefly-iii/issues/5173) Firefly III would email too often about logins\n- [Issue 5178](https://github.com/firefly-iii/firefly-iii/issues/5178) Fix export parameter\n- [Issue 5179](https://github.com/firefly-iii/firefly-iii/issues/5179) Possible fix for issue with empty date strings\n- [Issue 5196](https://github.com/firefly-iii/firefly-iii/issues/5196) Fix issue with foreign amount formatting\n- [Issue 5200](https://github.com/firefly-iii/firefly-iii/issues/5200) Link bill to recurring transaction\n- [Issue 5218](https://github.com/firefly-iii/firefly-iii/issues/5218) Error in search\n- [Issue 5226](https://github.com/firefly-iii/firefly-iii/issues/5226) Could submit negative \"skip\" values\n- [Issue 5229](https://github.com/firefly-iii/firefly-iii/issues/5229) Fix serviceworker registration\n\n\n\n### Security {#security_9}\n- Logout is now POST and other minor CSRF issues.\n\n\n## 5.6.2 - 2021-10-09 {#562-2021-10-09}\n\n\n\n### Added {#added_23}\n- `/health` will return `200 OK` if Firefly III is up and running, thanks @ajgon!\n- [Issue 5133](https://github.com/firefly-iii/firefly-iii/issues/5133) First version of the LDAP filter is up.\n- Option to log via Papertrail\n-\n\n### Deprecated {#deprecated_5}\n- PHP 7.4 will probably not work on any page.\n\n\n### Fixed {#fixed_70}\n- [Issue 5133](https://github.com/firefly-iii/firefly-iii/issues/5133) LDAP filter (partial fix)\n- [Issue 5134](https://github.com/firefly-iii/firefly-iii/issues/5134) Use of clone function from search menu.\n- [Issue 5143](https://github.com/firefly-iii/firefly-iii/issues/5143) v2 layout: account notes\n- [Issue 5144](https://github.com/firefly-iii/firefly-iii/issues/5144) Removal of rule triggers / actions broken\n- [Issue 5145](https://github.com/firefly-iii/firefly-iii/issues/5145) Crash due to null pointer\n- The markdown parser was broken.\n\n\n### Security {#security_10}\n- Fix [open direct](https://huntr.dev/bounties/549a1040-9b5e-420b-9b80-20700dd9d592/)\n- Fix [unrestricted upload](https://huntr.dev/bounties/5267ec1c-d204-40d2-bd4f-6c2dd495ee18/)\n\n\n## 5.6.1 - 2021-09-25 {#561-2021-09-25}\n\n\n\n### Fixed {#fixed_71}\n- [Issue 4997](https://github.com/firefly-iii/firefly-iii/issues/4997) Deleted transactions would get reimported.\n- [Issue 5100](https://github.com/firefly-iii/firefly-iii/issues/5100) Broken UI in v2.0 due to translation issues.\n- [Issue 5101](https://github.com/firefly-iii/firefly-iii/issues/5101) Text duplication\n- [Issue 5104](https://github.com/firefly-iii/firefly-iii/issues/5104) Date range fixes\n- [Issue 5109](https://github.com/firefly-iii/firefly-iii/issues/5109) Fixed LDAP configuration issues.\n- [Issue 5110](https://github.com/firefly-iii/firefly-iii/issues/5110) Service worker JS would interfere with back button.\n\n\n### Security {#security_11}\n- Fixed several low-key CSRF vulnerabilities.\n- Fixed an issue where you could spam the password reset form.\n\n\n### API {#api_23}\n- Deprecated the \"currencies with code\"-endpoint (see the [API documentation](/api/#tag-autocomplete)).\n- Add missing \"order\" field to budget.\n- Add missing \"rule_group_title\" to rules.\n- Attachment endpoint returns \"upload_url\" and \"download_url\" instead of \"*_uri\".\n\n\n## 5.6.0 - 2021-09-17 {#560-2021-09-17}\n\n\n⚠️ This release features new LDAP libraries. Your mileage may vary. Make sure you back up everything. Firefly III may accidentally create a new account for you instead of reusing the old one. There is no option for LDAP filters yet.\n\nPlease refer to the [documentation](https://docs.firefly-iii.org/firefly-iii/) and support channels if you run into problems:\n\n- [Gitter.im](https://gitter.im/firefly-iii/firefly-iii)\n- [Twitter](https://twitter.com/Firefly_III/)\n- [GitHub Issues](https://github.com/firefly-iii/firefly-iii/issues)\n- [GitHub Discussions](https://github.com/firefly-iii/firefly-iii/discussions)\n\n\n### Added {#added_24}\n- A few new pages for the new v2 layout. Thanks @alex6480!\n- Added a new currency, thanks @kasperkls02!\n- You can now manage loans and debts a little better, see also the documentation for help.\n- Some screenshots are now in the GitHub repository for better management, thanks @Flightkick!\n- @LBreda has added a service worker and updated icons, thanks!\n\n\n### Changed {#changed_25}\n- @hoshsadiq has added all PHP requirements to the composer file, thanks!\n- A better cache routine for layout v2 pages.\n- All LDAP libraries have been upgraded.\n- New issue templates and help text for easier GitHub support.\n- First preparations for multi-administration and group membership options.\n- The search will return nothing if you submit invalid values, instead of everything.\n\n\n### Removed {#removed_9}\n- All telemetry options have been removed.\n\n\n### Fixed {#fixed_72}\n- [Issue 4894](https://github.com/firefly-iii/firefly-iii/issues/4894) Bad number comparison\n- [Issue 4987](https://github.com/firefly-iii/firefly-iii/issues/4987) Budgeted amount includes inactive budgets\n- [Issue 4988](https://github.com/firefly-iii/firefly-iii/issues/4988) Can't select liability account from imported transactions\n- [Issue 5042](https://github.com/firefly-iii/firefly-iii/issues/5042) HTTP 500 when creating Personal Access Token or OAuth Client\n- Various Sonarqube issues, thanks @hazma-fadil!\n- Correct menu display, thanks @vonsogt!\n- The IBAN validator will filter special characters.\n- In some cases, piggy banks would report being full or empty while this was not actually the case.\n- Various other bugs and minor issues.\n\n\n### Security {#security_12}\n- Feature to be able to rebuild Docker images and show security warnings in new builds.\n- [CVE-2021-3663](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3663) A missing rate limiter makes brute-forcing the login easy.\n- It also fixes [CVE-2021-3728](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3728), [CVE-2021-3729](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3729) and [CVE-2021-3730](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3730), all variations of the same security vulnerability: some actions in Firefly III were vulnerable to CSRF.\n\n\n### API {#api_24}\n- You can disable webhooks with an extra field in API submissions.\n- There is a static cron token (see `.env.example`) which is useful for Docker.\n- A better endpoint to move transactions around, see [api-docs.firefly-iii.org](https://api-docs.firefly-iii.org).\n\n\n## 5.5.13 - 2021-07-25 {#5513-2021-07-25}\n\n\n\n### Security {#security_13}\n\n\n- This version of Firefly III fixes [CVE-2021-3663](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3663)\n\n\n## 5.5.12 - 2021-06-03 {#5512-2021-06-03}\n\n\n⚠️ On July 1st 2021 the Docker tag will change to `fireflyiii/core`. You can already start using the new tag.\n\n\n### Security {#security_14}\n\n\n- This version of Firefly III fixes a security vulnerability in the export routine. You are advised to upgrade as soon as possible. All credits to the excellent @oomb.\n\n\n## 5.5.11 - 2021-05-08 {#5511-2021-05-08}\n\n\n⚠️ On July 1st 2021 the Docker tag will change to `fireflyiii/core`. You can already start using the new tag.\n\n\n### Fixed {#fixed_73}\n- [Issue 4707](https://github.com/firefly-iii/firefly-iii/issues/4707) [issue 4732](https://github.com/firefly-iii/firefly-iii/issues/4732) Rule tests were broken, and matching transactions were not visible.\n- [Issue 4729](https://github.com/firefly-iii/firefly-iii/issues/4729) Top boxes were no longer visible.\n- [Issue 4730](https://github.com/firefly-iii/firefly-iii/issues/4730) Second split transaction had today's date\n- [Issue 4734](https://github.com/firefly-iii/firefly-iii/issues/4734) Potential fixes for PostgreSQL and PHP 7.4.18.\n- [Issue 4739](https://github.com/firefly-iii/firefly-iii/issues/4739) Was not possible to change liability type.\n\n\n## 5.5.10 - 2021-05-01 {#5510-2021-05-01}\n\n\n\n### Changed {#changed_26}\n- [Issue 4708](https://github.com/firefly-iii/firefly-iii/issues/4708) When searching for the external ID, Firefly III will now only return the exact match.\n\n\n### Fixed {#fixed_74}\n- [Issue 4545](https://github.com/firefly-iii/firefly-iii/issues/4545) Rare but annoying issue with PostgreSQL increments will be repaired during image boot time. Thanks @jaylenw!\n- [Issue 4710](https://github.com/firefly-iii/firefly-iii/issues/4710) Some rule actions could not handle liabilities.\n- [Issue 4715](https://github.com/firefly-iii/firefly-iii/issues/4715) Fixed some titles.\n- [Issue 4720](https://github.com/firefly-iii/firefly-iii/issues/4720) Could not remove a split in the new layout.\n\n\n## 5.5.9 (API 1.5.2) 2021-04-24 {#559-api-152-2021-04-24}\n\n\nThis update fixes some of the more annoying issues in the new experimental v2 layout (see also [GitHub](https://github.com/firefly-iii/firefly-iii/issues/4618)), but some minor other issues as well.\n\n\n### Fixed {#fixed_75}\n- Dashboard preferences would some times retain old or bad data.\n\n\n### API {#api_25}\n- [Issue 4697](https://github.com/firefly-iii/firefly-iii/issues/4697) Submitting an existing account with an account number only would store it as a new account.\n- [Issue 4706](https://github.com/firefly-iii/firefly-iii/issues/4706) Account interest was a float and not a string.\n- Store Budget API call would not properly handle auto budgets.\n\n\n## 5.5.8 (API 1.5.2) 2021-04-17 {#558-api-152-2021-04-17}\n\n\nThis update fixes some of the more annoying issues in the new experimental v2 layout (see also [GitHub](https://github.com/firefly-iii/firefly-iii/issues/4618)), but some minor other issues as well.\n\n\n### Fixed {#fixed_76}\n- [Issue 4656](https://github.com/firefly-iii/firefly-iii/issues/4656) [issue 4660](https://github.com/firefly-iii/firefly-iii/issues/4660) Various fixes in the v2 layout.\n- [Issue 4663](https://github.com/firefly-iii/firefly-iii/issues/4663) It was possible to assign a budget to a transfer.\n- [Issue 4664](https://github.com/firefly-iii/firefly-iii/issues/4664) Null pointer in bulk editor\n- [Issue 4668](https://github.com/firefly-iii/firefly-iii/issues/4668) Inactive rule groups would not be listed.\n\n\n## 5.5.7 (API 1.5.2) 2021-04-11 {#557-api-152-2021-04-11}\n\n\n\n### Added {#added_25}\n- [Issue 4627](https://github.com/firefly-iii/firefly-iii/issues/4627) The search and rule engine can search for any transaction with any bill or with no bill at all. Thanks, @devfaz!\n\n\n### Fixed {#fixed_77}\n- [Issue 4625](https://github.com/firefly-iii/firefly-iii/issues/4625) Old MySQL servers would choke on the migrations.\n- [Issue 4625](https://github.com/firefly-iii/firefly-iii/issues/4625) Some arrays are null when Firefly III starts for the first time.\n- [Issue 4628](https://github.com/firefly-iii/firefly-iii/issues/4628) Every transaction appeared to have attachments.\n- [Issue 4635](https://github.com/firefly-iii/firefly-iii/issues/4635) Export command ignores your dates. Thanks for the suggested fix, @urquilla!\n- [Issue 4646](https://github.com/firefly-iii/firefly-iii/issues/4646) Empty select list\n\n\n\n## 5.5.6 (API 1.5.2) 2021-04-09 {#556-api-152-2021-04-09}\n\n\nFirefly III features a new *experimental* layout that I'm currently building. You can enable it by setting environment variable `FIREFLY_III_LAYOUT=v2`. Check out [GitHub](https://github.com/firefly-iii/firefly-iii/issues/4618) for the announcement and status updates. This release features an update API version. Check out [the difference](https://github.com/firefly-iii/api-docs-generator/compare/1.5.1...1.5.2).\n\n\n### Fixed {#fixed_78}\n- [Issue 4593](https://github.com/firefly-iii/firefly-iii/issues/4593) Could not change or update recurring repetition data.\n- [Issue 4596](https://github.com/firefly-iii/firefly-iii/issues/4596) The error handler mailer mails about too many things.\n- [Issue 4603](https://github.com/firefly-iii/firefly-iii/issues/4603) Call to bad RSA method.\n- [Issue 4607](https://github.com/firefly-iii/firefly-iii/issues/4607) Bad code in set source / set destination rule actions meant that it would not fire in some cases.\n\n\n### Security {#security_15}\n- [Issue 4616](https://github.com/firefly-iii/firefly-iii/issues/4616) Firefly III has some extra security-related headers.\n\n\n### API {#api_26}\n- [Issue 4600](https://github.com/firefly-iii/firefly-iii/issues/4600) Sometimes empty amounts would not be properly picked up by the API.\n- New endpoint to bulk update transactions.\n- The chart API endpoint includes the time in the labels.\n\n\n## 5.5.5 {#555}\n\n\nSkipped.\n\n\n## 5.5.4 {#554}\n\n\nSkipped.\n\n\n## 5.5.3 (API 1.5.1) 2021-04-03 {#553-api-151-2021-04-03}\n\n\n\n### Changed {#changed_27}\n- Upgraded the render engine for the frontend.\n\n\n### Fixed {#fixed_79}\n- [Issue 4547](https://github.com/firefly-iii/firefly-iii/issues/4547) Call to bad function breaks several report.\n- [Issue 4545](https://github.com/firefly-iii/firefly-iii/issues/4545) Migration error in some cases, fixed with an if-statement.\n- [Issue 4557](https://github.com/firefly-iii/firefly-iii/issues/4557) LDAP configuration error in Docker image.\n- [Issue 4560](https://github.com/firefly-iii/firefly-iii/issues/4560) The account number would be stored in the BIC field, if the BIC field was set.\n- [Issue 4562](https://github.com/firefly-iii/firefly-iii/issues/4562) Hidden budgets were visible in v2.\n- [Issue 4567](https://github.com/firefly-iii/firefly-iii/issues/4567) Missing translation marked as intentionally missing.\n- [Issue 4570](https://github.com/firefly-iii/firefly-iii/issues/4570) It was impossible to set or change auto budgets.\n- [Issue 4571](https://github.com/firefly-iii/firefly-iii/issues/4571) New layout could be one day behind in some cases.\n- [Issue 4572](https://github.com/firefly-iii/firefly-iii/issues/4572) Link to reconcile page was broken.\n- [Issue 4574](https://github.com/firefly-iii/firefly-iii/issues/4574) 500-error when trying to update bills.\n- [Issue 4575](https://github.com/firefly-iii/firefly-iii/issues/4575) Add new date-ranges to the v2 index page.\n- [Issue 4578](https://github.com/firefly-iii/firefly-iii/issues/4578) Fixed some time selection issues in v2.\n- [Issue 4582](https://github.com/firefly-iii/firefly-iii/issues/4582) Inactive budgets would still get automated budget limits.\n\n\n### API {#api_27}\n\n\nThis release features an update API version. Check out [the difference](https://github.com/firefly-iii/api-docs-generator/compare/1.5.0...1.5.1).\n\n\n- All endpoints that used to deliver dates (`2021-04-27`) will now deliver date time strings (`2021-04-27T16:43:12+02:00`).\n- [Issue 4566](https://github.com/firefly-iii/firefly-iii/issues/4566) Some API end points did not deliver the promised data.\n\n\n## 5.5.2 {#552}\n\n\nSkipped.\n\n\n## 5.5.1 (API 1.5.0) 2021-03-27 {#551-api-150-2021-03-27}\n\n\n\n### Added {#added_26}\n\n\n- [Issue 3717](https://github.com/firefly-iii/firefly-iii/issues/3717) The CSV export will also export all optional metadata.\n- [Issue 4007](https://github.com/firefly-iii/firefly-iii/issues/4007) The message returned when updating transactions using a rull will return the number of changed transactions.\n- [Issue 4334](https://github.com/firefly-iii/firefly-iii/issues/4334) Support for Portuguese! 🇵🇹\n- [Issue 4338](https://github.com/firefly-iii/firefly-iii/issues/4338) The recurring transactions calendar was off by one day, this is now fixed.\n- [Issue 4339](https://github.com/firefly-iii/firefly-iii/issues/4339) A bad redirect would send you to a 404.\n- [Issue 4340](https://github.com/firefly-iii/firefly-iii/issues/4340) Any date related rule actions and triggers will pick up the correct date from the transaction.\n- [Issue 4406](https://github.com/firefly-iii/firefly-iii/issues/4406) SQL errors when submitting large amounts to the budget overview are now fixed.\n- [Issue 4412](https://github.com/firefly-iii/firefly-iii/issues/4412) The cron job could show you a null pointer.\n- [Issue 4488](https://github.com/firefly-iii/firefly-iii/issues/4488) The Japanese Yen has been corrected to zero decimals.\n- [Issue 4503](https://github.com/firefly-iii/firefly-iii/issues/4503) When bills skip a moment the amounts in the overview would be off.\n- Firefly III now supports [webhooks](https://docs.firefly-iii.org/firefly-iii/pages-and-features/webhooks/).\n- The search now also supports searching for transactions using `id:123`.\n\n\n### Changed {#changed_28}\n\n\n- OAuth settings are visible for LDAP users.\n- If you set `FIREFLY_III_LAYOUT=v2`, Firefly III will show you the new layout on pages where it's available.\n- A new favicon based on the future logo of Firefly III.\n- ⚠️ The URL to call the cron job from the web has changed to `api/v1/cron/[token here]`.\n\n\n### Deprecated {#deprecated_6}\n- The current layout will no longer receive fixes and changes.\n\n\n### Fixed {#fixed_80}\n- [Issue 4045](https://github.com/firefly-iii/firefly-iii/issues/4045) The error message for \"amount missing\" now has a look up value\n- [Issue 4055](https://github.com/firefly-iii/firefly-iii/issues/4055) The budget report crashed when opening.\n- [Issue 4060](https://github.com/firefly-iii/firefly-iii/issues/4060) The remote user guard would show a 500 error about type conversion.\n- [Issue 4070](https://github.com/firefly-iii/firefly-iii/issues/4070) Tagging recurring transactions would not work.\n- [Issue 4071](https://github.com/firefly-iii/firefly-iii/issues/4071) Selecting piggy banks in rules was broken.\n- [Issue 4074](https://github.com/firefly-iii/firefly-iii/issues/4074) Audit logging would break some Apache servers\n- [Issue 4098](https://github.com/firefly-iii/firefly-iii/issues/4098) Search reports \"Firefly III found 50 transactions in x seconds\" even when it only finds one.\n- [Issue 4108](https://github.com/firefly-iii/firefly-iii/issues/4108) Fix category update in bulk update.\n- [Issue 4112](https://github.com/firefly-iii/firefly-iii/issues/4112) Broken redirect after delete.\n- [Issue 4158](https://github.com/firefly-iii/firefly-iii/issues/4158) `strtolower` breaks some translations.\n- [Issue 4162](https://github.com/firefly-iii/firefly-iii/issues/4162) Stop processing does not stop other rules in rule group\n- [Issue 4169](https://github.com/firefly-iii/firefly-iii/issues/4169) Sorting by date on category Report sorts alphabetically instead.\n- [Issue 4175](https://github.com/firefly-iii/firefly-iii/issues/4175) Bad math in long periods.\n- [Issue 4186](https://github.com/firefly-iii/firefly-iii/issues/4186) Could not add translation link.\n- [Issue 4200](https://github.com/firefly-iii/firefly-iii/issues/4200) A rare null pointer exception when running rules.\n- [Issue 4207](https://github.com/firefly-iii/firefly-iii/issues/4207) Fix the \"spent per day\" box.\n- [Issue 4231](https://github.com/firefly-iii/firefly-iii/issues/4231) Inconsistent hiding of columns.\n- [Issue 4235](https://github.com/firefly-iii/firefly-iii/issues/4235) The info popup in the standard financial report does not apply report's account filter.\n- [Issue 4241](https://github.com/firefly-iii/firefly-iii/issues/4241) A broken chart works again.\n- [Issue 4520](https://github.com/firefly-iii/firefly-iii/issues/4520) RSA token generation is now PHP7/8 compatible.\n- [Issue 4529](https://github.com/firefly-iii/firefly-iii/issues/4529) Convert transaction routine was broken.\n- PHP configurations that have \"MB\" as size indicator would be parsed badly.\n\n\n### API {#api_28}\n\n\n⚠️ *Lots of API changes, make sure you read [the documentation](/api/).* ⚠️\n\n- [Issue 4050](https://github.com/firefly-iii/firefly-iii/issues/4050) Updated Transaction Search API to set limit from user preferences\n- [Issue 4113](https://github.com/firefly-iii/firefly-iii/issues/4113) Piggy Bank API Deletes Some Piggy Metadata\n- [Issue 4122](https://github.com/firefly-iii/firefly-iii/issues/4122) Remove reconciliation accounts from autocomplete\n- [Issue 4195](https://github.com/firefly-iii/firefly-iii/issues/4195) User endpoint was broken.\n- [Issue 4199](https://github.com/firefly-iii/firefly-iii/issues/4199) Unable to update tags using API.\n- [Issue 4394](https://github.com/firefly-iii/firefly-iii/issues/4394) Storing budgets works again.\n- [Issue 4426](https://github.com/firefly-iii/firefly-iii/issues/4426) Storing accounts would lead to bad capitalization in liability type.\n- [Issue 4435](https://github.com/firefly-iii/firefly-iii/issues/4435) Storing piggy banks with object group information would fail.\n- Users can submit almost any field without other fields changing as well.\n\n\n## 5.5.0 {#550}\n\n\nSkipped.\n\n\n## 5.4.6 (API 1.4.0) - 2020-10-07 {#546-api-140-2020-10-07}\n\n\n\n### Added {#added_27}\n- [Issue 4031](https://github.com/firefly-iii/firefly-iii/issues/4031) Rule groups can be collapsed.\n- [Issue 4002](https://github.com/firefly-iii/firefly-iii/issues/4002) Category now support notes, although they're not displayed anywhere yet.\n\n\n### Changed {#changed_29}\n- Upgrade to Laravel 8\n\n\n### Fixed {#fixed_81}\n- [Issue 4001](https://github.com/firefly-iii/firefly-iii/issues/4001) [issue 4005](https://github.com/firefly-iii/firefly-iii/issues/4005) [issue 4011](https://github.com/firefly-iii/firefly-iii/issues/4011) Special characters are double escaped.\n- [Issue 4006](https://github.com/firefly-iii/firefly-iii/issues/4006) Unclear error message fixed.\n- [Issue 4015](https://github.com/firefly-iii/firefly-iii/issues/4015) Better handling of headers in Apache.\n- [Issue 4023](https://github.com/firefly-iii/firefly-iii/issues/4023) Fix issue with logout and admin view.\n- Missing help text can now be translated.\n- Demo sites send messages to me, not \"demo@firefly\".\n\n\n## 5.4.5 (API 1.4.0) - 2020-10-28 {#545-api-140-2020-10-28}\n\n\n\n### Fixed {#fixed_82}\n- [Issue 3853](https://github.com/firefly-iii/firefly-iii/issues/3853) Could not create rules with IBAN values.\n- [Issue 3991](https://github.com/firefly-iii/firefly-iii/issues/3991) Hardcoded array key broke editing.\n- [Issue 3992](https://github.com/firefly-iii/firefly-iii/issues/3992) Amount problems in account chart for multi-currency charts.\n- [Issue 4000](https://github.com/firefly-iii/firefly-iii/issues/4000) Budget chart did not handle multiple currencies well.\n- [Issue 4003](https://github.com/firefly-iii/firefly-iii/issues/4003) Was unable to create new auto budget limits in foreign currency.\n\n\n### Security {#security_16}\n- [Issue 3990](https://github.com/firefly-iii/firefly-iii/issues/3990) Unescaped content could break the auto-complete.\n\n\n## 5.4.4 (API 1.4.0) - 2020-10-24 {#544-api-140-2020-10-24}\n\n\n\n### Changed {#changed_30}\n- [Issue 3885](https://github.com/firefly-iii/firefly-iii/issues/3885) You can create a user from CLI.\n- Various code changes and upgrades. See [issue 3957](https://github.com/firefly-iii/firefly-iii/issues/3957)\n\n\n### Fixed {#fixed_83}\n- [Issue 3871](https://github.com/firefly-iii/firefly-iii/issues/3871) Remove initial balance accounts from the auto-complete list.\n- [Issue 3898](https://github.com/firefly-iii/firefly-iii/issues/3898) It was impossible to rename a group.\n- [Issue 3900](https://github.com/firefly-iii/firefly-iii/issues/3900) Execution of inactive rules.\n- [Issue 3901](https://github.com/firefly-iii/firefly-iii/issues/3901) Rules not executed in correct order.\n- [Issue 3902](https://github.com/firefly-iii/firefly-iii/issues/3902) Rule values for target account id not accepted.\n- [Issue 3903](https://github.com/firefly-iii/firefly-iii/issues/3903) Long search queries may break the query parser.\n- [Issue 3909](https://github.com/firefly-iii/firefly-iii/issues/3909) Foreign amount button was hidden.\n- [Issue 3913](https://github.com/firefly-iii/firefly-iii/issues/3913) Extra space in currency name.\n- [Issue 3914](https://github.com/firefly-iii/firefly-iii/issues/3914) Bad paths.\n- [Issue 3915](https://github.com/firefly-iii/firefly-iii/issues/3915) LDAP users could not use tokens.\n- [Issue 3940](https://github.com/firefly-iii/firefly-iii/issues/3940) Fix broken links\n- [Issue 3942](https://github.com/firefly-iii/firefly-iii/issues/3942) Bad data validation\n- [Issue 3953](https://github.com/firefly-iii/firefly-iii/issues/3953) Renaming categories would not rename the recurring transactions' category.\n- [Issue 3968](https://github.com/firefly-iii/firefly-iii/issues/3968) Remove group from bill was broken.\n- [Issue 3973](https://github.com/firefly-iii/firefly-iii/issues/3973) Remove attachment broken reference.\n- [Issue 3974](https://github.com/firefly-iii/firefly-iii/issues/3974) Remove account from preferences when set inactive.\n- [Issue 3978](https://github.com/firefly-iii/firefly-iii/issues/3978) Fix budget index\n- [Issue 3983](https://github.com/firefly-iii/firefly-iii/issues/3983) Fix old help links\n- [Issue 3985](https://github.com/firefly-iii/firefly-iii/issues/3985) Old SQL parameter removed.\n\n\n## 5.4.3 (API 1.4.0) - 2020-10-03 {#543-api-140-2020-10-03}\n\n\n\n### Added {#added_28}\n- [Issue 3592](https://github.com/firefly-iii/firefly-iii/issues/3592) You can now add an alternative email address to users when using the external user guard. See the `.env.example` for instructions.\n- [Issue 3863](https://github.com/firefly-iii/firefly-iii/issues/3863) Sonarcloud.io badges in the readme file, thanks @lastlink\n- Support for Slovak\n\n\n### Changed {#changed_31}\n- [Issue 3875](https://github.com/firefly-iii/firefly-iii/issues/3875) Budgets also count foreign currency transactions.\n- Docker image runs PHP 7.4.11\n\n\n### Fixed {#fixed_84}\n- [Issue 3824](https://github.com/firefly-iii/firefly-iii/issues/3824) Hard-coded links broken.\n- [Issue 3850](https://github.com/firefly-iii/firefly-iii/issues/3850) Preview was broken for boolean search operators\n- [Issue 3853](https://github.com/firefly-iii/firefly-iii/issues/3853) Broken rule triggers when handling accounts.\n- [Issue 3855](https://github.com/firefly-iii/firefly-iii/issues/3855) Broken manifest file.\n- [Issue 3858](https://github.com/firefly-iii/firefly-iii/issues/3858) Broken pagination, thanks @sephrat.\n- [Issue 3862](https://github.com/firefly-iii/firefly-iii/issues/3862) Split transactions could not be edited.\n- [Issue 3879](https://github.com/firefly-iii/firefly-iii/issues/3879) Category popup broken.\n- [Issue 3881](https://github.com/firefly-iii/firefly-iii/issues/3881) Could store multiple budget limits due to a broken check.\n- [Issue 3884](https://github.com/firefly-iii/firefly-iii/issues/3884) Transaction edit form was improperly updated when removing splits.\n- [Issue 3887](https://github.com/firefly-iii/firefly-iii/issues/3887) Could not remove bill from transaction.\n- [Issue 3893](https://github.com/firefly-iii/firefly-iii/issues/3893) Fix budget bars.\n- [Issue 3894](https://github.com/firefly-iii/firefly-iii/issues/3894) Fix auto-complete code.\n- Budget overview properly takes weekly budgets into account, even when on a monthly list.\n\n\n### API {#api_29}\n- [Issue 3880](https://github.com/firefly-iii/firefly-iii/issues/3880) Could not post new amount.\n\n\n## 5.4.2 (API 1.4.0) - 2020-09-24 {#542-api-140-2020-09-24}\n\n\nFixes exotic and regression bugs.\n\n\n### Added {#added_29}\n- [Issue 3828](https://github.com/firefly-iii/firefly-iii/issues/3828) The admin pages now respect LDAP.\n\n\n### Fixed {#fixed_85}\n- LDAP and 2FA should work again.\n- [Issue 3822](https://github.com/firefly-iii/firefly-iii/issues/3822) Fix web manifest file.\n- [Issue 3823](https://github.com/firefly-iii/firefly-iii/issues/3823) [issue 3837](https://github.com/firefly-iii/firefly-iii/issues/3837) Several pages fail when no notes are present in the object.\n- [Issue 3826](https://github.com/firefly-iii/firefly-iii/issues/3826) Long non-English words could break the login page.\n- [Issue 3831](https://github.com/firefly-iii/firefly-iii/issues/3831) Filtering on notes did not work properly.\n- [Issue 3839](https://github.com/firefly-iii/firefly-iii/issues/3839) Cannot display tag details\n- [Issue 3840](https://github.com/firefly-iii/firefly-iii/issues/3840) Search + rule engine breaks for various filters\n- [Issue 3841](https://github.com/firefly-iii/firefly-iii/issues/3841) \"Bill\" value required on split transaction\n- [Issue 3842](https://github.com/firefly-iii/firefly-iii/issues/3842) Missing translations.\n- [Issue 3843](https://github.com/firefly-iii/firefly-iii/issues/3843) Can't use boolean filters in rule creation\n- [Issue 3844](https://github.com/firefly-iii/firefly-iii/issues/3844) Correct filter use from rule engine\n- [Issue 3847](https://github.com/firefly-iii/firefly-iii/issues/3847) Setting available amount did not work.\n\n\n## 5.4.1 (API 1.4.0) - 2020-09-21 {#541-api-140-2020-09-21}\n\n\nAs usual, a same-day release fixing some exotic bugs.\n\n\n### Added {#added_30}\n- DB version info.\n\n\n### Fixed {#fixed_86}\n- [Issue 3809](https://github.com/firefly-iii/firefly-iii/issues/3809) Issue with LDAP logins fixed.\n- [Issue 3816](https://github.com/firefly-iii/firefly-iii/issues/3816) Issue with account lists being empty.\n\n\n## 5.4.0 (API 1.4.0) - 2020-09-21 {#540-api-140-2020-09-21}\n\n\nSome warnings before you install this version:\n\n- ⚠️ Some changes in this release may be backwards incompatible (see below).\n- ⚠️ Invalid triggers in a non-strict rule will cause Firefly III to select ALL transactions.\n- ⚠️ The `export` volume is no longer used (Docker).\n- ⚠️ The `upload` volume is now located at `/var/www/html/storage/upload` (Docker).\n\nSeveral alpha and beta releases preceded this release.\n\n- 5.4.0-alpha.1 on 2020-08-14\n- 5.4.0-alpha.2 on 2020-08-21\n- 5.4.0-alpha.3 on 2020-08-21\n- 5.4.0-beta.1 on 2020-09-13\n\n\n### Known issues {#known-issues}\n\n\nYep, unfortunately.\n\n- [Issue 3808](https://github.com/firefly-iii/firefly-iii/issues/3808) When using the remote authentication features of Firefly III, autocomplete endpoints will fail.\n\n\n### Added {#added_31}\n- [Issue 3187](https://github.com/firefly-iii/firefly-iii/issues/3187) A new field for transaction URL's.\n- [Issue 3200](https://github.com/firefly-iii/firefly-iii/issues/3200) The ability to sort your accounts as you see fit.\n- [Issue 3213](https://github.com/firefly-iii/firefly-iii/issues/3213) Add totals to the budget page.\n- [Issue 3238](https://github.com/firefly-iii/firefly-iii/issues/3238) You can select an expense when creating a transaction.\n- [Issue 3240](https://github.com/firefly-iii/firefly-iii/issues/3240) Meta data and UI changes to count recurring transactions.\n- [Issue 3246](https://github.com/firefly-iii/firefly-iii/issues/3246) Ability to add tags in the mass editor, not just replace them.\n- [Issue 3265](https://github.com/firefly-iii/firefly-iii/issues/3265) A warning when split transactions may be changed by Firefly III.\n- [Issue 3382](https://github.com/firefly-iii/firefly-iii/issues/3382) Fixed transfers not showing the right +/- sign, by @sephrat\n- [Issue 3435](https://github.com/firefly-iii/firefly-iii/issues/3435) Create a recurring transaction from a single transaction.\n- [Issue 3451](https://github.com/firefly-iii/firefly-iii/issues/3451) Add a message on the bottom of the transaction screen so you see any errors.\n- [Issue 3475](https://github.com/firefly-iii/firefly-iii/issues/3475) A summary for the box with bills.\n- [Issue 3583](https://github.com/firefly-iii/firefly-iii/issues/3583) You can set your own custom guard header for third party authentication.\n- [Issue 3604](https://github.com/firefly-iii/firefly-iii/issues/3604) Add CI support by @hoshsadiq\n- [Issue 3638](https://github.com/firefly-iii/firefly-iii/issues/3638) Added better UTF8 support on Windows, by @sephrat\n- [Issue 3642](https://github.com/firefly-iii/firefly-iii/issues/3642) Redis now supports Unix sockets.\n- [Issue 3648](https://github.com/firefly-iii/firefly-iii/issues/3648) Add a basic copy/paste feature.\n- [Issue 3651](https://github.com/firefly-iii/firefly-iii/issues/3651) Now supports public clients.\n- [Issue 3755](https://github.com/firefly-iii/firefly-iii/issues/3755) You can now click option groups in the report pages.\n- [Issue 3765](https://github.com/firefly-iii/firefly-iii/issues/3765) Tag page sum list is now currency aware.\n- A new integrity check that makes sure all transaction types are correct.\n- Support for Bulgarian! 🇧🇬\n\n\n### Changed {#changed_32}\n- ⚠️ All auto-complete code now uses the API; let me know if errors occur.\n- ⚠️ New rule processing engine, which is much faster than the old one, especially on large datasets. Expect several magnitudes of time improvements.\n- ⚠️ Many new search operators, which are documented [in the documentation](https://docs.firefly-iii.org/concepts/search).\n- [Issue 3578](https://github.com/firefly-iii/firefly-iii/issues/3578) Use php-intl to do currency formatting, made by @hoshsadiq\n- [Issue 3586](https://github.com/firefly-iii/firefly-iii/issues/3586) Removed features that aren't necessary when using third party auth providers.\n- [Issue 3659](https://github.com/firefly-iii/firefly-iii/issues/3659) Update the readme to include third party apps.\n- Fixed audit logs.\n\n\n### Fixed {#fixed_87}\n- [Issue 3519](https://github.com/firefly-iii/firefly-iii/issues/3519) Locales should work better on Windows 10.\n- [Issue 3577](https://github.com/firefly-iii/firefly-iii/issues/3577) Add liability accounts when transforming transactions.\n- [Issue 3585](https://github.com/firefly-iii/firefly-iii/issues/3585) Fix issue with category lists in reports.\n- [Issue 3598](https://github.com/firefly-iii/firefly-iii/issues/3598) [issue 3597](https://github.com/firefly-iii/firefly-iii/issues/3597) Bad code in create recurring page, fixed by @maroux\n- [Issue 3630](https://github.com/firefly-iii/firefly-iii/issues/3630) Fix the cron job used for auto budgeting.\n- [Issue 3635](https://github.com/firefly-iii/firefly-iii/issues/3635) Fix a copy/paste error in translations, by @sephrat\n- [Issue 3638](https://github.com/firefly-iii/firefly-iii/issues/3638) Remove unused warning, by @sephrat\n- [Issue 3639](https://github.com/firefly-iii/firefly-iii/issues/3639) Remove unused translations, by @sephrat\n- [Issue 3640](https://github.com/firefly-iii/firefly-iii/issues/3640) Hide empty budget lists, by @sephrat\n- [Issue 3641](https://github.com/firefly-iii/firefly-iii/issues/3641) Elegant solution to fix piggy bank groups, by @sephrat\n- [Issue 3673](https://github.com/firefly-iii/firefly-iii/issues/3673) Search limit was ignored.\n- [Issue 3675](https://github.com/firefly-iii/firefly-iii/issues/3675) Was unable to update transaction currency.\n- [Issue 3678](https://github.com/firefly-iii/firefly-iii/issues/3678) Search did not distinguish between source and destination.\n- [Issue 3679](https://github.com/firefly-iii/firefly-iii/issues/3679) Polish and Russian translations were broken on the `/rules` page, fixed by @sephrat\n- [Issue 3681](https://github.com/firefly-iii/firefly-iii/issues/3681) Fix Czech translations missing file on `/profile` page.\n- [Issue 3693](https://github.com/firefly-iii/firefly-iii/issues/3693) Creating users through the API was impossible.\n- [Issue 3696](https://github.com/firefly-iii/firefly-iii/issues/3696) Fix missing translations, by @sephrat\n- [Issue 3710](https://github.com/firefly-iii/firefly-iii/issues/3710) When you create a split transaction, the title isn't correctly reset.\n- [Issue 3745](https://github.com/firefly-iii/firefly-iii/issues/3745) In some cases, piggy bank events were not created.\n- [Issue 3746](https://github.com/firefly-iii/firefly-iii/issues/3746) Bad anchor link in readme, thanks @GrayStrider\n- [Issue 3748](https://github.com/firefly-iii/firefly-iii/issues/3748) Typo's in autocomplete URL, thanks @psychowood\n- [Issue 3759](https://github.com/firefly-iii/firefly-iii/issues/3759) Bad budget calculations when using out-of-sync budgets.\n- [Issue 3761](https://github.com/firefly-iii/firefly-iii/issues/3761) Could not create a transfer and refer to a piggy bank by name.\n- [Issue 3768](https://github.com/firefly-iii/firefly-iii/issues/3768) Attachments were uploaded out of order in split transactions.\n- [Issue 3770](https://github.com/firefly-iii/firefly-iii/issues/3770) Null pointer exception when creating transaction.\n- [Issue 3772](https://github.com/firefly-iii/firefly-iii/issues/3772) Some strings were translated badly.\n- [Issue 3789](https://github.com/firefly-iii/firefly-iii/issues/3789) Heroku installation failed because of bad DB code.\n- [Issue 3791](https://github.com/firefly-iii/firefly-iii/issues/3791) Several issues on the budgets page fixed.\n- Reconciliation transactions now show the amount correctly.\n\n\n### API {#api_30}\n- [Issue 3150](https://github.com/firefly-iii/firefly-iii/issues/3150) New routes for easy auto complete in 3rd party applications.\n- New endpoint for the transaction links of a specific transaction.\n\n\n## 5.3.3 (API 1.3.0) - 2020-07-17 {#533-api-130-2020-07-17}\n\n\n\n### Fixed {#fixed_88}\n- [Issue 3565](https://github.com/firefly-iii/firefly-iii/issues/3565) Spelling error in API array.\n- [Issue 3566](https://github.com/firefly-iii/firefly-iii/issues/3566) Fix issue in bills chart.\n- [Issue 3568](https://github.com/firefly-iii/firefly-iii/issues/3568) Fix issue with floating number.\n- [Issue 3573](https://github.com/firefly-iii/firefly-iii/issues/3573) Fix link in readme.\n- [Issue 3574](https://github.com/firefly-iii/firefly-iii/issues/3574) Fix issue with floating number.\n\n\n## 5.3.2 (API 1.3.0) - 2020-07-13 {#532-api-130-2020-07-13}\n\n\n\n### Fixed {#fixed_89}\n- Issue when installing Firefly III using composer.\n- Issue when installing Firefly III using the latest Docker image.\n\n\n## 5.3.1 (API 1.3.0) - 2020-07-12 {#531-api-130-2020-07-12}\n\n\n\n### Added {#added_32}\n- Extra logging in case of database errors at first launch.\n\n\n### Changed {#changed_33}\n- Completely rewrote the [security policy](https://github.com/firefly-iii/firefly-iii/security/policy).\n\n\n### Fixed {#fixed_90}\n- [Issue 3532](https://github.com/firefly-iii/firefly-iii/issues/3532) Fix empty validation messages.\n- Profile methods to change email / password were broken.\n- Heroku will build again.\n- Some integers were not properly cast to strings.\n- Fixed several timezone issues when generated the dashboard account chart.\n\n\n### API {#api_31}\n- [Issue 3546](https://github.com/firefly-iii/firefly-iii/issues/3546) New endpoints to selectively delete data.\n- [Issue 3554](https://github.com/firefly-iii/firefly-iii/issues/3554) Consistent parsing for amounts.\n\n\n## 5.3.0 (API 1.2.0) - 2020-07-03 {#530-api-120-2020-07-03}\n\n\nSeveral alpha and beta releases preceded this release.\n\n- 5.3.0-alpha.1 on 2020-06-22\n- 5.3.0-beta.1 on 2020-06-28\n- 5.3.0-beta.1 on 2020-07-01\n\n\n### Added {#added_33}\n- [Issue 3184](https://github.com/firefly-iii/firefly-iii/issues/3184) You can now use the `REMOTE_USER` field to authenticate. Read [the documentation](https://docs.firefly-iii.org/advanced-installation/authentication#remote-user) carefully.\n- [Issue 3392](https://github.com/firefly-iii/firefly-iii/issues/3392) Notes will be included in the export.\n- [Issue 3398](https://github.com/firefly-iii/firefly-iii/issues/3398) You can clear the cache directly from the admin.\n- [Issue 3403](https://github.com/firefly-iii/firefly-iii/issues/3403) More triggers have been added that respond to the date of a transaction. Read [the documentation](https://docs.firefly-iii.org/advanced-concepts/rules)\n- Piggy banks and bills can be divided over groups. Groups can be sorted on a separate page. This may prove to be useful to organize these objects. The feature\n  will expand to even more objects in the future. Empty groups will be automatically deleted; you can only create groups by editing the objects.\n- You can now add attachments to recurring transactions.\n- You can invalidate other logins, check out the button on the `/profile` page.\n- It is now possible to search for `internal_reference:abc` and / or `external_id:123`.\n- The bill overview has some better sums on the bottom of the page.\n\n\n### Changed {#changed_34}\n- [Issue 3440](https://github.com/firefly-iii/firefly-iii/issues/3440) You can now sort rules more easily.\n- [Issue 3455](https://github.com/firefly-iii/firefly-iii/issues/3455) There are new translations for the debug page.\n- [Issue 3461](https://github.com/firefly-iii/firefly-iii/issues/3461) Inactive rules are no longer applied, even when you try to force them.\n- [Issue 3469](https://github.com/firefly-iii/firefly-iii/issues/3469) Fix issue with `round()`.\n- Firefly III now requires **PHP 7.4**. PHP7.4 specific features have been introduced to make sure you upgrade.\n- The Docker image is running on **port 8080**. Please update your configuration to reflect this.\n- Firefly III has been upgraded to Laravel 7.\n- From this release on, the Dockerfile and default configuration will install MySQL (using MariaDB) instead of PostgreSQL. This doesn't influence existing\n  installations.\n- The example environment file has several fixes to make it more clear what features are for.\n- Sandstorm support is now entirely decrepated.\n- The max upload size is now larger. Although mostly enforced by your server, Firefly III used to have a very low upper limit.\n- The `MAIL_DRIVER` variable is now called `MAIL_MAILER`.\n\n\n### Removed {#removed_10}\n- [Issue 3517](https://github.com/firefly-iii/firefly-iii/issues/3517) The category no longer shows income because it skewed the chart and made it useless.\n- All import routines have been removed. Use the separate importers. Read [the documentation](https://docs.firefly-iii.org/importing-data/introduction).\n- No more locale settings if using Docker.\n\n\n### Fixed {#fixed_91}\n- [Issue 3450](https://github.com/firefly-iii/firefly-iii/issues/3450) Brought back missing translations.\n- [Issue 3454](https://github.com/firefly-iii/firefly-iii/issues/3454) Fixed some translations.\n- [Issue 3437](https://github.com/firefly-iii/firefly-iii/issues/3437) The \"days left\" counter now responds better.\n- [Issue 3427](https://github.com/firefly-iii/firefly-iii/issues/3427) HTML included in error codes\n- [Issue 3489](https://github.com/firefly-iii/firefly-iii/issues/3489) Several unescaped strings.\n- [Issue 3490](https://github.com/firefly-iii/firefly-iii/issues/3490) Fix search issues when using special characters.\n- [Issue 3488](https://github.com/firefly-iii/firefly-iii/issues/3488) Fix token text box.\n- [Issue 3509](https://github.com/firefly-iii/firefly-iii/issues/3509) Tag view now handles future transactions better.\n- [Issue 3513](https://github.com/firefly-iii/firefly-iii/issues/3513) Fix issue with charts on budget page.\n- Fixed a null pointer in session date.\n- Fixed bad UUID generation.\n- Internal consistency checks for transaction groups.\n- The bill date would some times report the future.\n\n\n### API {#api_32}\n- [Issue 3493](https://github.com/firefly-iii/firefly-iii/issues/3493) Fix API issue when handling default currencies.\n- [Issue 3506](https://github.com/firefly-iii/firefly-iii/issues/3506) Search transactions end point\n- New API for object groups.\n- Expanded API for piggy banks to support object groups.\n- Expanded API for bills to support object groups.\n\n\n### Known issues {#known-issues_1}\n- You may run into date conversion problems if you're living on the right side of GMT. If transactions appear a day early, let me know.\n\n\n## 5.2.8 (API 1.1.0) - 2020-06-02 {#528-api-110-2020-06-02}\n\n\n\n### Fixed {#fixed_92}\n- [Issue 3443](https://github.com/firefly-iii/firefly-iii/issues/3443) Fixed issue with composer installation.\n\n\n## 5.2.7 (API 1.1.0) - 2020-06-01 {#527-api-110-2020-06-01}\n\n\n\n### Added {#added_34}\n- Firefly III **optional + opt-in** telemetry can now be enabled, if you want to. Read more about it [here](https://docs.firefly-iii.org/support/telemetry).\n- [Issue 3133](https://github.com/firefly-iii/firefly-iii/issues/3133) You can remove attachments before you create a transaction.\n- [Issue 3395](https://github.com/firefly-iii/firefly-iii/issues/3395) Emails sent by Firefly III have been translated. See the note at the bottom. Thanks to @sephrat\n- [Issue 3393](https://github.com/firefly-iii/firefly-iii/issues/3393) New SSL options for LDAP and MySQL. Thanks to @bpatath.\n- [Issue 3413](https://github.com/firefly-iii/firefly-iii/issues/3413) Better string pluralization. Thanks to @sephrat\n- [Issue 3297](https://github.com/firefly-iii/firefly-iii/issues/3297) Rule trigger for foreign currency ID\n\n\n### Changed {#changed_35}\n- The default Docker Compose configuration and documentation switched from PostgreSQL to MariaDB. This will NOT affect existing installations unless you\n  change your docker compose file.\n- [Issue 3404](https://github.com/firefly-iii/firefly-iii/issues/3404) The profile page has been translated. See the note at the bottom. Thanks to @sephrat\n- [Issue 3405](https://github.com/firefly-iii/firefly-iii/issues/3405) All error pages have been translated. See the note at the bottom. Thanks to @sephrat\n\n\n### Fixed {#fixed_93}\n- [Issue 3309](https://github.com/firefly-iii/firefly-iii/issues/3309) New budgets would create bad budget limits.\n- [Issue 3390](https://github.com/firefly-iii/firefly-iii/issues/3390) Typos and minor text inconsistencies fixed by @sephrat\n- [Issue 3407](https://github.com/firefly-iii/firefly-iii/issues/3407) [issue 3408](https://github.com/firefly-iii/firefly-iii/issues/3408) The total transaction amount displayed is no longer empty for opening balances by @sephrat\n- [Issue 3409](https://github.com/firefly-iii/firefly-iii/issues/3409) [issue 3420](https://github.com/firefly-iii/firefly-iii/issues/3420) Double accounts no longer listed by @sephrat\n- [Issue 3427](https://github.com/firefly-iii/firefly-iii/issues/3427) Add a time-out to version update check. More improvements are coming.\n- [Issue 3419](https://github.com/firefly-iii/firefly-iii/issues/3419) Error fixed which would prevent you from adding money to a piggy bank, by @sephrat\n- [Issue 3425](https://github.com/firefly-iii/firefly-iii/issues/3425) Budget amount had no validation.\n- [Issue 3428](https://github.com/firefly-iii/firefly-iii/issues/3428) Reconciliation \"select all\"-button would miscalculate.\n- [Issue 3415](https://github.com/firefly-iii/firefly-iii/issues/3415) New error views\n\nA note about new translations: text you see in errors and emails may still be in English. This is not a bug. Translated text is sometimes generated outside of\nwhat's called the user's \"session\". When Firefly III operates outside of your session, it can't access your preferences or your data. It doesn't know what\nlanguage to pick. You can set the `DEFAULT_LANGUAGE`-environment variable. But user specific preferences may be ignored.\n\n\n## 5.2.6 (API 1.1.0) - 2020-05-22 {#526-api-110-2020-05-22}\n\n\n\n### Added {#added_35}\n- [Issue 3049](https://github.com/firefly-iii/firefly-iii/issues/3049) New transaction triggers for dates.\n- Warning if recurring transactions no longer run.\n- View fixed for recurring transactions.\n- A new rule action that will DELETE transactions.\n- Four-week reminder to check for updates if you disabled updates.\n\n\n### Changed {#changed_36}\n- [Issue 3011](https://github.com/firefly-iii/firefly-iii/issues/3011) Reconciliation page has \"select all\"-button and remembers checkboxes even when you refresh the page.\n- [Issue 3348](https://github.com/firefly-iii/firefly-iii/issues/3348) Smarter menu for accounts on the dashboard\n- Demo user can't upload attachments.\n- Demo user can't set locale.\n\n\n### Fixed {#fixed_94}\n- [Issue 3339](https://github.com/firefly-iii/firefly-iii/issues/3339) Could not mass-delete reconciliation transactions.\n- [Issue 3344](https://github.com/firefly-iii/firefly-iii/issues/3344) Could not attach files to accounts.\n- [Issue 3335](https://github.com/firefly-iii/firefly-iii/issues/3335) Fix reconciliation currency account, thanks to @maksimkurb\n- [Issue 3350](https://github.com/firefly-iii/firefly-iii/issues/3350) Better charts in account overview\n- [Issue 3355](https://github.com/firefly-iii/firefly-iii/issues/3355) Better sorting for bills in reports.\n- [Issue 3363](https://github.com/firefly-iii/firefly-iii/issues/3363) New strings translated, thanks to @sephrat\n- [Issue 3367](https://github.com/firefly-iii/firefly-iii/issues/3367) Error in views when uploading > 1 attachments\n- [Issue 3368](https://github.com/firefly-iii/firefly-iii/issues/3368) Wrong hover-text\n- [Issue 3374](https://github.com/firefly-iii/firefly-iii/issues/3374) Inconsistent net worth calculation. You may seem to lose money.\n- [Issue 3376](https://github.com/firefly-iii/firefly-iii/issues/3376) Better rule ordering when cloning rules.\n- [Issue 3381](https://github.com/firefly-iii/firefly-iii/issues/3381) Fix for LDAP\n- Better rounding for budget amounts.\n\n\n## 5.2.5 (API 1.1.0) - 2020-05-04 {#525-api-110-2020-05-04}\n\n\n\n### Added {#added_36}\n- Some warnings that custom locales may not work on Windows or in Docker images.\n\n\n### Changed {#changed_37}\n- [Issue 3305](https://github.com/firefly-iii/firefly-iii/issues/3305) User [@lguima](https://github.com/lguima) revamped the left side menu and associated icons.\n\n\n### Fixed {#fixed_95}\n- [Issue 3307](https://github.com/firefly-iii/firefly-iii/issues/3307) Editing or creating accounts would automatically give them a location.\n- [Issue 3314](https://github.com/firefly-iii/firefly-iii/issues/3314) Future transactions would not always be visible, even when the daterange should include them.\n- [Issue 3318](https://github.com/firefly-iii/firefly-iii/issues/3318) Cron called over URL would skip auto-budgets.\n- [Issue 3321](https://github.com/firefly-iii/firefly-iii/issues/3321) API for piggy bank funds would create events with the wrong amount.\n- [Issue 3330](https://github.com/firefly-iii/firefly-iii/issues/3330) Transactions not stored at 00:00 would be excluded from some views.\n\n\n## 5.2.4 (API 1.1.0) - 2020-04-26 {#524-api-110-2020-04-26}\n\n\n\n### Fixed {#fixed_96}\n- [Issue 3287](https://github.com/firefly-iii/firefly-iii/issues/3287) Locale issue\n- [Issue 3251](https://github.com/firefly-iii/firefly-iii/issues/3251) Budget order\n\n\n## 5.2.3 (API 1.1.0) - 2020-04-22 {#523-api-110-2020-04-22}\n\n\n\n### Added {#added_37}\n- Support for British English! 🇬🇧\n- You can set your locale *and* your language now.\n\n\n### Changed {#changed_38}\n- [Issue 3270](https://github.com/firefly-iii/firefly-iii/issues/3270) Wrong average in budget table.\n\n\n### Fixed {#fixed_97}\n- [Issue 3264](https://github.com/firefly-iii/firefly-iii/issues/3264) Error when exporting recurring transactions\n- [Issue 3272](https://github.com/firefly-iii/firefly-iii/issues/3272) Rule issue when using \"set source account\" action.\n- [Issue 3281](https://github.com/firefly-iii/firefly-iii/issues/3281) Bad markdown parsing in piggy banks.\n- [Issue 3284](https://github.com/firefly-iii/firefly-iii/issues/3284) Recurring transactions with bad info couldn't be rendered.\n\n\n## 5.2.2 (API 1.1.0) - 2020-04-14 {#522-api-110-2020-04-14}\n\n\n\n### Fixed {#fixed_98}\n- [Issue 3529](https://github.com/firefly-iii/firefly-iii/issues/3529) Issue with rule execution.\n- [Issue 3263](https://github.com/firefly-iii/firefly-iii/issues/3263) Issue with new user account creation.\n\n\n## 5.2.2 (API 1.1.0) - 2020-04-13 {#522-api-110-2020-04-13}\n\n\n\n### Fixed {#fixed_99}\n- Virtual balance would always be stored as \"0.0\" despite the field being nullable.\n- The rule action \"set source account\" was improperly configured.\n\n\n## 5.2.1 (API 1.1.0) - 2020-04-10 {#521-api-110-2020-04-10}\n\n\nFirefly III 5.2.1 fixes an issue with charts and allows users to store budgets again.\n\n\n## 5.2.0 (API 1.1.0) - 2020-04-10 {#520-api-110-2020-04-10}\n\n\n- ⚠️ This will be the last version to support PHP version 7.3. The next release will require PHP **7.4**\n- ⚠️ The bunq and CSV import routines have been disabled and replaced by their stand alone variants: [bunq](https://github.com/firefly-iii/bunq-importer), [CSV](https://github.com/firefly-iii/csv-importer).\n\nThis release was preceded by a number of test versions:\n\n- 5.2.0-alpha.1 on 2020-03-24\n- 5.2.0-beta.1 on 2020-04-02\n\n\n### Added {#added_38}\n- [Issue 2578](https://github.com/firefly-iii/firefly-iii/issues/2578) Allows users to create automatic budget configurations to rollover or set periodic limits.\n- [Issue 2726](https://github.com/firefly-iii/firefly-iii/issues/2726) Added new pie charts on the transaction index pages.\n- [Issue 2957](https://github.com/firefly-iii/firefly-iii/issues/2957) A new button to duplicate rules\n- [Issue 2828](https://github.com/firefly-iii/firefly-iii/issues/2828) More objects now support attachments: accounts, bills, budgets, categories, piggy banks and tags.\n- [Issue 2938](https://github.com/firefly-iii/firefly-iii/issues/2938) Expense and revenue accounts show their balances better.\n- [Issue 2977](https://github.com/firefly-iii/firefly-iii/issues/2977) On the budget page, the bars and amounts auto update.\n- [Issue 3079](https://github.com/firefly-iii/firefly-iii/issues/3079) Version is now visible in the footer on mobile.\n- Support for Vietnamese 🇻🇳\n\n\n### Changed {#changed_39}\n- [Issue 2985](https://github.com/firefly-iii/firefly-iii/issues/2985) Updating an object (like a budget or a bill) will also update the associated rule, if any.\n- [Issue 3057](https://github.com/firefly-iii/firefly-iii/issues/3057) Several form changes to improve the usability of the transaction input form.\n- [Issue 3048](https://github.com/firefly-iii/firefly-iii/issues/3048) Rules can now handle liabilities as source or destination.\n- [Issue 2999](https://github.com/firefly-iii/firefly-iii/issues/2999) The category chart on the frontpage now displays income.\n- [Issue 2997](https://github.com/firefly-iii/firefly-iii/issues/2997) The tag list has categories.\n- [Issue 3122](https://github.com/firefly-iii/firefly-iii/issues/3122) Buttons on the top of lists.\n- The Docker maximum file attachment size has been increased to 64M.\n- The CSV file importer has been disabled. Find the [new CSV importer on GitHub](https://github.com/firefly-iii/csv-importer).\n\n\n### Fixed {#fixed_100}\n- [Issue 3154](https://github.com/firefly-iii/firefly-iii/issues/3154) `bcadd()` problems for users who were already running PHP7.4.\n- [Issue 3193](https://github.com/firefly-iii/firefly-iii/issues/3193) Copying a reconciled transaction correctly removes the reconciliation status.\n- [Issue 3003](https://github.com/firefly-iii/firefly-iii/issues/3003) Tables will look less crowded on your phone.\n- [Issue 3202](https://github.com/firefly-iii/firefly-iii/issues/3202) A bug in the frontpage budget chart is fixed.\n- [Issue 3203](https://github.com/firefly-iii/firefly-iii/issues/3203) Firefly III won't complain when using a locale that uses comma's as decimal separators.\n- [Issue 3212](https://github.com/firefly-iii/firefly-iii/issues/3212) Issue with ING imports.\n- [Issue 3210](https://github.com/firefly-iii/firefly-iii/issues/3210) Could not create rule based on a transaction from a dropdown menu.\n- [Issue 3234](https://github.com/firefly-iii/firefly-iii/issues/3234) Export didn't export tags.\n\n\n### API {#api_33}\n- [Issue 2828](https://github.com/firefly-iii/firefly-iii/issues/2828) Appropriate endpoints for new transaction possibilities.\n- [Issue 2958](https://github.com/firefly-iii/firefly-iii/issues/2958) A new default currency endpoint.\n\n\n## 5.1.1 (API 1.0.2) - 2020-03-13 {#511-api-102-2020-03-13}\n\n\n\n### Added {#added_39}\n- [Issue 2672](https://github.com/firefly-iii/firefly-iii/issues/2672) Buttons to create transactions from the list of accounts is back.\n\n\n### Changed {#changed_40}\n- [Issue 3176](https://github.com/firefly-iii/firefly-iii/issues/3176) Greek language support is enabled again!\n\n\n### Fixed {#fixed_101}\n- [Issue 3160](https://github.com/firefly-iii/firefly-iii/issues/3160) Deleting a reconciliation won't send you to a 404.\n- [Issue 3172](https://github.com/firefly-iii/firefly-iii/issues/3172) Remaining amount left calculation is wrong over multiple months.\n- [Issue 3173](https://github.com/firefly-iii/firefly-iii/issues/3173) Amount is invisible when viewing transactions.\n- [Issue 3177](https://github.com/firefly-iii/firefly-iii/issues/3177) Fix attachment breadcrumb.\n- [Issue 3180](https://github.com/firefly-iii/firefly-iii/issues/3180) Improve instructions for when the user loses MFA info.\n- [Issue 3182](https://github.com/firefly-iii/firefly-iii/issues/3182) Better fallback when transaction errors out.\n- Search modifiers are now case insensitive.\n\n\n### Security {#security_17}\n- The minimal password length for new users is now 16 characters.\n- Have I Been Pwnd check is now enabled by default.\n\n\n### API {#api_34}\n- A new call to `apply_rules` is available when submitting transactions.\n\n\n## 5.1.0 (API 1.0.1) - 2020-03-06 {#510-api-101-2020-03-06}\n\n\nBefore this release came out, several alpha and beta versions had been released already:\n\n- 5.1.0-alpha.1 on 2020-02-16\n- 5.1.0-beta.1 on 2020-02-23\n\n\n### Added {#added_40}\n- [Issue 2575](https://github.com/firefly-iii/firefly-iii/issues/2575) You can now create a transaction from a rule.\n- [Issue 3052](https://github.com/firefly-iii/firefly-iii/issues/3052) The old way of cloning transactions is back.\n- Firefly III will generate a unique installation ID for itself.\n\n\n### Changed {#changed_41}\n- [Issue 3066](https://github.com/firefly-iii/firefly-iii/issues/3066) [issue 3067](https://github.com/firefly-iii/firefly-iii/issues/3067) New tag overview. Not yet sure what works best.\n- [Issue 3071](https://github.com/firefly-iii/firefly-iii/issues/3071) Top box with expense information (left to spend) is now more clear.\n- [Issue 3075](https://github.com/firefly-iii/firefly-iii/issues/3075) Embarrassing typo in welcome email.\n- You can set the default language for Firefly III which will also apply to the login page.\n- Add Lando to readme.\n- Add support for Finnish! 🇫🇮\n- In the configuration `pgsql` is now the default database connection. This may break your non-`pgsql` installation if you haven't set it specifically to your database type.\n- A new debug view for transactions. Change the word \"show\" in `/transactions/show/123` to \"debug\" to get a nice JSON thing.\n- Foreign currencies should show up less often in edit/create transaction screens.\n\n\n### Fixed {#fixed_102}\n- [Issue 3042](https://github.com/firefly-iii/firefly-iii/issues/3042) Rule engine behavior was inconsistent when importing data.\n- [Issue 3045](https://github.com/firefly-iii/firefly-iii/issues/3045) Linking bills to liability accounts through rules was broken.\n- [Issue 3050](https://github.com/firefly-iii/firefly-iii/issues/3050) Date blocks were rendered badly.\n- [Issue 3070](https://github.com/firefly-iii/firefly-iii/issues/3070) The currency symbol would not precede the amount in some locales.\n- [Issue 3083](https://github.com/firefly-iii/firefly-iii/issues/3083) Fix category sort in report.\n- [Issue 3064](https://github.com/firefly-iii/firefly-iii/issues/3064) Weird bug in reports.\n- [Issue 3073](https://github.com/firefly-iii/firefly-iii/issues/3073) Rules would not be applied to all splits if a split was newly created.\n- [Issue 3099](https://github.com/firefly-iii/firefly-iii/issues/3099) Can't make piggy banks on accounts with no currency.\n- [Issue 3111](https://github.com/firefly-iii/firefly-iii/issues/3111) Budget amount edit redirect.\n- [Issue 3114](https://github.com/firefly-iii/firefly-iii/issues/3114) Removed double entry from budget list.\n- [Issue 3119](https://github.com/firefly-iii/firefly-iii/issues/3119) Command would break if transaction was incomplete.\n- [Issue 3127](https://github.com/firefly-iii/firefly-iii/issues/3127) Cloning a transaction would not clear the cache.\n- [Issue 3129](https://github.com/firefly-iii/firefly-iii/issues/3129) Issue importing interest dates.\n- [Issue 3130](https://github.com/firefly-iii/firefly-iii/issues/3130) A forwarder sent you to a 404.\n- [Issue 3131](https://github.com/firefly-iii/firefly-iii/issues/3131) The search modifiers would claim the whole query.\n- [Issue 3135](https://github.com/firefly-iii/firefly-iii/issues/3135) Could not change liability type.\n- [Issue 3137](https://github.com/firefly-iii/firefly-iii/issues/3137) Fix mis-alignment in table rows.\n- [Issue 3140](https://github.com/firefly-iii/firefly-iii/issues/3140) New user email message had a broken link.\n- [Issue 3141](https://github.com/firefly-iii/firefly-iii/issues/3141) Cache issue\n- [Issue 3145](https://github.com/firefly-iii/firefly-iii/issues/3145) Issue with empty charts.\n- [Issue 3146](https://github.com/firefly-iii/firefly-iii/issues/3146) Better handling of CSV imports from ING.\n- [Issue 3154](https://github.com/firefly-iii/firefly-iii/issues/3154) Problem with bcadd() in PHP 7.4\n- [Issue 3159](https://github.com/firefly-iii/firefly-iii/issues/3159) Fixed some untranslatable strings.\n- Bad redirect when editing opening balances.\n\n\n### API {#api_35}\n- [Issue 3097](https://github.com/firefly-iii/firefly-iii/issues/3097) Unifying API models\n- [Issue 3098](https://github.com/firefly-iii/firefly-iii/issues/3098) Add field to link types.\n\n\n## 5.0.5 (API 1.0.0) - 2020-02-13 {#505-api-100-2020-02-13}\n\n\nThis release fixes an issue with logging that could, in rare cases, error out terribly.\n\n\n### Fixed {#fixed_103}\n\n\n- Inconsistent log configuration.\n\n\n## 5.0.4 (API 1.0.0) - 2020-02-01 {#504-api-100-2020-02-01}\n\n\nThis release fixes several bugs found in 5.0.0 and earlier releases.\n\n\n### Fixed {#fixed_104}\n\n\n- If unset, `DB_CONNECTION` defaults to \"mysql\". This is now \"pgsql\", which is consistent with the documentation and the example configuration\n  file (`.env.example`).\n\n\n## 5.0.3 (API 1.0.0) - 2020-01-30 {#503-api-100-2020-01-30}\n\n\nThis release fixes several bugs found in 5.0.0 and earlier releases.\n\n\n### Fixed {#fixed_105}\n\n\n- A script tries to connect over MySQL, despite Firefly III being configured to connect over another DB type.\n\n\n## 5.0.1 (API 1.0.0) - 2020-01-25 {#501-api-100-2020-01-25}\n\n\nThis release fixes several bugs found in 5.0.0 and earlier releases.\n\n\n### Changed {#changed_42}\n- Rewrote the readme file.\n- Add Cloudron to readme.\n- Add a new import tool to the readme and the documentation.\n- Changed my email address to james@firefly-iii.org.\n\n\n### Fixed {#fixed_106}\n- [Issue 2998](https://github.com/firefly-iii/firefly-iii/issues/2998) Could not edit account with double IBAN\n- [Issue 3016](https://github.com/firefly-iii/firefly-iii/issues/3016) Swap min/max on chart and reverse direction\n- [Issue 3021](https://github.com/firefly-iii/firefly-iii/issues/3021) Fixed an issue with a broken button when uploading transactions\n- [Issue 3026](https://github.com/firefly-iii/firefly-iii/issues/3026) Fix issue with ISO dates\n- [Issue 3027](https://github.com/firefly-iii/firefly-iii/issues/3027) Opening Balance date and charts\n- [Issue 3019](https://github.com/firefly-iii/firefly-iii/issues/3019) Fix issue with bill name auto-complete in rules\n- [Issue 3047](https://github.com/firefly-iii/firefly-iii/issues/3047) Fix issue where new users would get big fat error.\n- Fixed an issue with the budget overview in default financial reports.\n\n\n## 5.0.0 (API 1.0.0) - 2020-01-18 {#500-api-100-2020-01-18}\n\n\nThis version represents, if anything, a fresh start in the version numbering system so Firefly III will finally follow SemVer, for real this time.\n\n\n### Added {#added_41}\n- [Issue 2580](https://github.com/firefly-iii/firefly-iii/issues/2580) Users can now edit reconciliations.\n- [Issue 2723](https://github.com/firefly-iii/firefly-iii/issues/2723) You can now use rules that trigger on account numbers (and IBAN)\n- [Issue 2895](https://github.com/firefly-iii/firefly-iii/issues/2895) Another indicator for negative amounts.\n- [Issue 2901](https://github.com/firefly-iii/firefly-iii/issues/2901) Can select liability accounts when running rules.\n- [Issue 2893](https://github.com/firefly-iii/firefly-iii/issues/2893) Add config cache clear command to Docker build.\n- [Issue 2667](https://github.com/firefly-iii/firefly-iii/issues/2667) Option to export data from Firefly III\n- [Issue 2064](https://github.com/firefly-iii/firefly-iii/issues/2064) Ability to mass-delete tags.\n- [Issue 2920](https://github.com/firefly-iii/firefly-iii/issues/2920) [issue 2981](https://github.com/firefly-iii/firefly-iii/issues/2981) Firefly III now generates a nonce used by all inline scripts.\n- Can now give accounts a location tag.\n- Firefly III now supports redis as cache backend.\n- Footer will warn you of alpha and beta versions.\n\n\n### Changed {#changed_43}\n- [Issue 2776](https://github.com/firefly-iii/firefly-iii/issues/2776) Some charts now do relative scaling. Useful for large amounts.\n- [Issue 2702](https://github.com/firefly-iii/firefly-iii/issues/2702) More details on tags overview\n- [Issue 2919](https://github.com/firefly-iii/firefly-iii/issues/2919) Didn't support user's choice not to check for updates.\n- Fine tune the Docker container startup times using new environment variables.\n- Firefly III's demo site no longer uses Google Analytics to track visitors, but Matomo.\n\n\n### Deprecated {#deprecated_7}\n- Firefly III no longer supports the SFTP storage backend, nor does it support the ability to use both SFTP and local files as storage backends, because the\n  packages required are no longer maintained and will not work with Laravel 6.0.\n\n\n### Removed {#removed_11}\n- Firefly III will no longer be built for Sandstorm.\n- The Docker image is built from [a separate repository](http://github.com/firefly-iii/docker).\n- The Kubernetes files are stored in [a separate repository](https://github.com/firefly-iii/kubernetes).\n\n\n### Fixed {#fixed_107}\n- [Issue 2907](https://github.com/firefly-iii/firefly-iii/issues/2907) Bad date display in recurring transactions.\n- [Issue 2912](https://github.com/firefly-iii/firefly-iii/issues/2912) Redirect fix for bills.\n- [Issue 2874](https://github.com/firefly-iii/firefly-iii/issues/2874) More redirect issues fixed.\n- [Issue 2878](https://github.com/firefly-iii/firefly-iii/issues/2878) Typo in code of budget overview.\n- [Issue 2876](https://github.com/firefly-iii/firefly-iii/issues/2876) Trailing zeroes and other issues.\n- [Issue 2881](https://github.com/firefly-iii/firefly-iii/issues/2881) An error when only the title of a split transaction was bad.\n- [Issue 2924](https://github.com/firefly-iii/firefly-iii/issues/2924) Could not trigger rules when set to \"update\".\n- [Issue 2691](https://github.com/firefly-iii/firefly-iii/issues/2691) Fix to update recurring transactions with bad types.\n- [Issue 2941](https://github.com/firefly-iii/firefly-iii/issues/2941) Not all notes were decoded correctly.\n- [Issue 2945](https://github.com/firefly-iii/firefly-iii/issues/2945) Budget field would be empty when editing transaction.\n- [Issue 2950](https://github.com/firefly-iii/firefly-iii/issues/2950) Error in chart (null pointer)\n- [Issue 2983](https://github.com/firefly-iii/firefly-iii/issues/2983) Debug info left in bills overview caused some issues.\n- [Issue 2980](https://github.com/firefly-iii/firefly-iii/issues/2980) Issues with console export.\n- [Issue 2987](https://github.com/firefly-iii/firefly-iii/issues/2987) Issue with creating expense / revenue accounts.\n- [Issue 2993](https://github.com/firefly-iii/firefly-iii/issues/2993) Issue with Chinese locale on Heroku\n\n\n### API {#api_36}\n- Various endpoints are better documented.\n\n\n\n## 4.8.2 (API 0.10.5) - 2019-11-29 {#482-api-0105-2019-11-29}\n\n\nAfter several alpha and beta versions (which were mainly released because I was\nfarting around with the idea of doing these things) here's the final version\nof the latest release, 4.8.2. Several improvements and lots of bug fixes.\n\n\n### Added {#added_42}\n- You can now cash out a liability.\n- (Better) support for Kubernetes\n- Support for Swedish! 🇸🇪\n\n\n### Changed {#changed_44}\n- [Issue 2835](https://github.com/firefly-iii/firefly-iii/issues/2835) Extended generic bank debit/credit indicator\n- Firefly III now comes in three channels: stable, beta and alpha. You can\n  find the latest version for each channel on [this website](https://version.firefly-iii.org/).\n- Firefly III will use version.firefly-iii.org to check what the latest version is.\n- Firefly III is now built for ARM, ARM64 and AMD64 in one Docker build.\n\n\n### Fixed {#fixed_108}\n- [Issue 2783](https://github.com/firefly-iii/firefly-iii/issues/2783) Fixes issues with SQLite databases.\n- [Issue 2774](https://github.com/firefly-iii/firefly-iii/issues/2774) Bad redirect when using exotic ports.\n- [Issue 2780](https://github.com/firefly-iii/firefly-iii/issues/2780) Budget overview would show deleted entries.\n- [Issue 2771](https://github.com/firefly-iii/firefly-iii/issues/2771) Tags and piggy banks would not be created when recurring transactions were created.\n- Not all lists would sort accounts properly.\n- [Issue 2786](https://github.com/firefly-iii/firefly-iii/issues/2786) Nicolas fixed documentation links, thanks!\n- [Issue 2806](https://github.com/firefly-iii/firefly-iii/issues/2806) You can now skip one month again in bills.\n- [Issue 2796](https://github.com/firefly-iii/firefly-iii/issues/2796) Rewrote a chart on category page.\n- [Issue 2811](https://github.com/firefly-iii/firefly-iii/issues/2811) Description of tags was gone.\n- [Issue 2812](https://github.com/firefly-iii/firefly-iii/issues/2812) Bad redirect after tag deletion.\n- [Issue 2790](https://github.com/firefly-iii/firefly-iii/issues/2790) Form fixes for currencies.\n- [Issue 2651](https://github.com/firefly-iii/firefly-iii/issues/2651) Source account would not be removed if resubmitting the form.\n- Catch some integer conversion errors.\n- [Issue 2660](https://github.com/firefly-iii/firefly-iii/issues/2660) Various search and form issues.\n- [Issue 2807](https://github.com/firefly-iii/firefly-iii/issues/2807) Timendum fixed a lot of auto-completes, thanks!\n- [Issue 2820](https://github.com/firefly-iii/firefly-iii/issues/2820) Fix budget chart.\n- [Issue 2832](https://github.com/firefly-iii/firefly-iii/issues/2832) Issue with rules.\n- [Issue 2841](https://github.com/firefly-iii/firefly-iii/issues/2841) Issue with duplicate imports.\n- [Issue 2843](https://github.com/firefly-iii/firefly-iii/issues/2843) Issues with Chinese translations\n- [Issue 2852](https://github.com/firefly-iii/firefly-iii/issues/2852) Missing columns from budget overview\n- [Issue 2851](https://github.com/firefly-iii/firefly-iii/issues/2851) Missing chart data.\n\n\n### API {#api_37}\n- Most API errors now have a number. See [this page](https://docs.firefly-iii.org/support/error_codes) for more details.\n\n\n## 4.8.2-alpha.1 (API 0.10.5) - 2019-11-03 {#482-alpha1-api-0105-2019-11-03}\n\n\nNormally I won't be detailling alpha versions in the changelog but this is a\nspecial one. If your Firefly III installation warned you that this version has\nbeen released, please take note that this is a **test** version and may **not**\nbe stable!\n\n\n### Changed {#changed_45}\n- Firefly III now comes in three channels: stable, beta and alpha. You can\n  find the latest version for each channel on [this website](https://version.firefly-iii.org/).\n- To make sure your Docker instance logs everything to `stdout`, make sure\n  you set the environment variable `LOG_CHANNEL` to `docker_out`. This is now\n  default behavior for new installations that use the `.env` file to launch\n  Firefly III (using Docker compose), but if you use environment variables\n  you may have to set this yourself. This is not a mandatory change but will\n  make debugging easier.\n- The Docker image is now also available in AArch64.\n\n\n### Fixed {#fixed_109}\n- [Issue 2771](https://github.com/firefly-iii/firefly-iii/issues/2771) Recurring transactions would not hit their piggy bank.\n- [Issue 2774](https://github.com/firefly-iii/firefly-iii/issues/2774) Fixed redirect issues for exotic URL's.\n- [Issue 2780](https://github.com/firefly-iii/firefly-iii/issues/2780) Deleted bugs would still count in the budget overview.\n- [Issue 2783](https://github.com/firefly-iii/firefly-iii/issues/2783) Fixed issue with SQLite and integers.\n- [Issue 2786](https://github.com/firefly-iii/firefly-iii/issues/2786) Fix links to documentation.\n\n\n## 4.8.1.8 (API 0.10.5) - 2019-10-26 {#4818-api-0105-2019-10-26}\n\n\n\n### Fixed {#fixed_110}\n- [Issue 2773](https://github.com/firefly-iii/firefly-iii/issues/2773) Error when importing transactions.\n\n\n## 4.8.1.7 (API 0.10.5) - 2019-10-26 {#4817-api-0105-2019-10-26}\n\n\n\n### Fixed {#fixed_111}\n- Error when creating transactions from the index of Firefly III.\n\n\n### API {#api_38}\n- Firefly III can filter duplicate transactions.\n- New endpoint that can search for specific transfers.\n\n\n## 4.8.1.6 (API 0.10.4) - 2019-10-25 {#4816-api-0104-2019-10-25}\n\n\n\n### Fixed {#fixed_112}\n- Redirecting to an URL with parameters works well now for editing and creating transactions.\n- [Issue 2756](https://github.com/firefly-iii/firefly-iii/issues/2756) Search was broken due to left-over debug statements.\n- [Issue 2757](https://github.com/firefly-iii/firefly-iii/issues/2757) 2FA was broken due to a changed library.\n- [Issue 2758](https://github.com/firefly-iii/firefly-iii/issues/2758) A debug command courtesy of Laravel wouldn't work due to invalid routes.\n- [Issue 2701](https://github.com/firefly-iii/firefly-iii/issues/2701) Fixed a never-ending loop.\n\n\n## 4.8.1.5 (API 0.10.4) - 2019-10-21 {#4815-api-0104-2019-10-21}\n\n\n\n### Added {#added_43}\n- [Issue 2694](https://github.com/firefly-iii/firefly-iii/issues/2694) Special page for archived accounts.\n\n\n### Changed {#changed_46}\n- [Issue 2540](https://github.com/firefly-iii/firefly-iii/issues/2540) Partly translated transaction edit/create form.\n- [Issue 2655](https://github.com/firefly-iii/firefly-iii/issues/2655) Link to Firefly III's base Docker image.\n- [Issue 2724](https://github.com/firefly-iii/firefly-iii/issues/2724) Cleanup some JS output.\n- [Issue 2734](https://github.com/firefly-iii/firefly-iii/issues/2734) Put personal access token in textarea for easier copy/pasting.\n- [Issue 2728](https://github.com/firefly-iii/firefly-iii/issues/2728) Remove superfluous currency names.\n\n\n### Fixed {#fixed_113}\n- [Issue 2699](https://github.com/firefly-iii/firefly-iii/issues/2699) Internal cache wouldn't update.\n- [Issue 2713](https://github.com/firefly-iii/firefly-iii/issues/2713) Could not search for numerical values.\n- [Issue 2716](https://github.com/firefly-iii/firefly-iii/issues/2716) Could not reset intro popups.\n- [Issue 2701](https://github.com/firefly-iii/firefly-iii/issues/2701) Temporary fix for timeouts.\n- [Issue 2727](https://github.com/firefly-iii/firefly-iii/issues/2727) CSP headers too strict.\n- [Issue 2731](https://github.com/firefly-iii/firefly-iii/issues/2731) Too strict config vars.\n- [Issue 2754](https://github.com/firefly-iii/firefly-iii/issues/2754) Memcached config would error out.\n- [Issue 2746](https://github.com/firefly-iii/firefly-iii/issues/2746) Cache would not clear after firing recurring transactions.\n- [Issue 2755](https://github.com/firefly-iii/firefly-iii/issues/2755) Making a rule inactive would still fire it.\n\n\n### API {#api_39}\n- [Issue 2698](https://github.com/firefly-iii/firefly-iii/issues/2698) Fix return value in API.\n- [Issue 2753](https://github.com/firefly-iii/firefly-iii/issues/2753) Was possible to upload and manage empty attachments.\n- New accounts submitted through the API may include account number, BIC and IBAN data.\n- New end point to support [issue 2752](https://github.com/firefly-iii/firefly-iii/issues/2752).\n\n\n## 4.8.1.4 (API 0.10.3) - 2019-10-05 {#4814-api-0103-2019-10-05}\n\n\nEmergency fix because I borked the upgrade routine. I apologise for the inconvenience.\n\n\n### Fixed {#fixed_114}\n- [Issue 2680](https://github.com/firefly-iii/firefly-iii/issues/2680) Upgrade routine would delete all transaction groups.\n\n\n## 4.8.1.2 (API 0.10.3) - 2019-10-05 {#4812-api-0103-2019-10-05}\n\n\nFirefly III v4.8.1.2 and onwards are licensed under the GNU Affero General\nPublic License. This will not meaningfully change Firefly III. This\nparticular license has some extra provisions that protect web-applications\nsuch as this one. You can read the full license on the website of GNU.\n\nhttps://www.gnu.org/licenses/agpl-3.0.html\n\n\n### Added {#added_44}\n- [Issue 2589](https://github.com/firefly-iii/firefly-iii/issues/2589) Can now search using `created_on:2019-10-22` and `updated_on:2019-10-22`.\n- [Issue 2494](https://github.com/firefly-iii/firefly-iii/issues/2494) Add account balance to the dropdown.\n- [Issue 2603](https://github.com/firefly-iii/firefly-iii/issues/2603) New keywords for reports.\n- [Issue 2618](https://github.com/firefly-iii/firefly-iii/issues/2618) Page navigation in the footer of transaction lists.\n- Option in your profile to delete meta-data from your administration.\n- Add average to some reports.\n\n\n### Changed {#changed_47}\n- [Issue 2593](https://github.com/firefly-iii/firefly-iii/issues/2593) The budget overview is now fully multi-currency.\n- [Issue 2613](https://github.com/firefly-iii/firefly-iii/issues/2613) Improved Mailgun configuration options.\n- [Issue 2510](https://github.com/firefly-iii/firefly-iii/issues/2510) Maximum transaction description length is 1000 now.\n- [Issue 2616](https://github.com/firefly-iii/firefly-iii/issues/2616) Docker instances should remember their OAuth tokens and keys better (even after a restart)\n- [Issue 2675](https://github.com/firefly-iii/firefly-iii/issues/2675) Some spelling in the English is fixed.\n\n\n### Removed {#removed_12}\n- [Issue 2677](https://github.com/firefly-iii/firefly-iii/issues/2677) Superfluous help popup.\n\n\n### Fixed {#fixed_115}\n- [Issue 2572](https://github.com/firefly-iii/firefly-iii/issues/2572) Sometimes users would get 404's after deleting stuff.\n- [Issue 2587](https://github.com/firefly-iii/firefly-iii/issues/2587) Users would be redirected to JSON endpoints.\n- [Issue 2596](https://github.com/firefly-iii/firefly-iii/issues/2596) Could not remove the last tag from a transaction.\n- [Issue 2598](https://github.com/firefly-iii/firefly-iii/issues/2598) Fix an issue where foreign amounts were displayed incorrectly.\n- [Issue 2599](https://github.com/firefly-iii/firefly-iii/issues/2599) Could add negative amounts to piggy banks and game the system.\n- [Issue 2560](https://github.com/firefly-iii/firefly-iii/issues/2560) Search supports møre chäracters.\n- [Issue 2626](https://github.com/firefly-iii/firefly-iii/issues/2626) Budgets would display amounts with too many decimals.\n- [Issue 2629](https://github.com/firefly-iii/firefly-iii/issues/2629) [issue 2639](https://github.com/firefly-iii/firefly-iii/issues/2639) [issue 2640](https://github.com/firefly-iii/firefly-iii/issues/2640) [issue 2643](https://github.com/firefly-iii/firefly-iii/issues/2643) Line-breaks were not properly rendered in markdown.\n- [Issue 2623](https://github.com/firefly-iii/firefly-iii/issues/2623) Budget spent line would make the start of the month twice.\n- [Issue 2624](https://github.com/firefly-iii/firefly-iii/issues/2624) Editing a budget would redirect you to the wrong page.\n- [Issue 2633](https://github.com/firefly-iii/firefly-iii/issues/2633) New transaction form sorts budgets wrong.\n- [Issue 2567](https://github.com/firefly-iii/firefly-iii/issues/2567) Could not unlink bills.\n- [Issue 2647](https://github.com/firefly-iii/firefly-iii/issues/2647) Date issue in category overview\n- [Issue 2657](https://github.com/firefly-iii/firefly-iii/issues/2657) Possible fix for issue with transaction overview.\n- [Issue 2658](https://github.com/firefly-iii/firefly-iii/issues/2658) Fixed overview of recurring transactions.\n- [Issue 2480](https://github.com/firefly-iii/firefly-iii/issues/2480) SQLite can't handle a lot of variables so big update queries are now executed in chunks.\n- [Issue 2683](https://github.com/firefly-iii/firefly-iii/issues/2683) Link to the wrong transaction.\n\n\n\n### Security {#security_18}\n- [Issue 2687](https://github.com/firefly-iii/firefly-iii/issues/2687) Budget overview shows budget limit totals for all users, not just the logged-in user.\n\n\n### API {#api_40}\n- [Issue 2609](https://github.com/firefly-iii/firefly-iii/issues/2609) Summary endpoint would not always give the correct results.\n- [Issue 2638](https://github.com/firefly-iii/firefly-iii/issues/2638) Link to correct journal in API.\n- [Issue 2606](https://github.com/firefly-iii/firefly-iii/issues/2606) Budget endpoint gave error.\n- [Issue 2637](https://github.com/firefly-iii/firefly-iii/issues/2637) Transaction / piggy bank event endpoint now returns results.\n- An undocumented end point that allows you to search for accounts. Still a bit experimental.\n  Use: /api/v1/search/accounts?query=something&field=all (all,iban,id,number)\n\n\n## 4.8.1.1 (API 0.10.2) - 2019-09-12 {#4811-api-0102-2019-09-12}\n\n\n\n### Changed {#changed_48}\n- Add some sensible maximum amounts to form inputs.\n\n\n### Fixed {#fixed_116}\n- [Issue 2561](https://github.com/firefly-iii/firefly-iii/issues/2561) Fixes a query error on the /tags page that affected some MySQL users.\n- [Issue 2563](https://github.com/firefly-iii/firefly-iii/issues/2563) Two destination fields when editing a recurring transaction.\n- [Issue 2564](https://github.com/firefly-iii/firefly-iii/issues/2564) Ability to browse pages in the search results.\n- [Issue 2573](https://github.com/firefly-iii/firefly-iii/issues/2573) Could not submit an transaction update after an error was corrected.\n- [Issue 2577](https://github.com/firefly-iii/firefly-iii/issues/2577) Upgrade routine would wrongly store the categories of split transactions.\n- [Issue 2590](https://github.com/firefly-iii/firefly-iii/issues/2590) Fix an issue in the audit report.\n- [Issue 2592](https://github.com/firefly-iii/firefly-iii/issues/2592) Fix an issue with YNAB import.\n- [Issue 2597](https://github.com/firefly-iii/firefly-iii/issues/2597) Fix an issue where users could not delete currencies.\n\n\n## 4.8.1 (API 0.10.2) - 2019-09-08 {#481-api-0102-2019-09-08}\n\n\nFirefly III 4.8.1 requires PHP 7.3.\n\n\n### Added {#added_45}\n- Support for Greek\n- [Issue 2383](https://github.com/firefly-iii/firefly-iii/issues/2383) Some tables in reports now also report percentages.\n- [Issue 2389](https://github.com/firefly-iii/firefly-iii/issues/2389) Add category / budget information to transaction lists.\n- [Issue 2464](https://github.com/firefly-iii/firefly-iii/issues/2464) Can now search for tag.\n- [Issue 2466](https://github.com/firefly-iii/firefly-iii/issues/2466) Can order recurring transactions in a more useful manner.\n- [Issue 2497](https://github.com/firefly-iii/firefly-iii/issues/2497) Transaction creation moment in hover of tag title.\n- [Issue 2471](https://github.com/firefly-iii/firefly-iii/issues/2471) Added date tag to table cells.\n\n\n### Changed {#changed_49}\n- [Issue 2285](https://github.com/firefly-iii/firefly-iii/issues/2285) Rule handling is now uniform across the app.\n- [Issue 2231](https://github.com/firefly-iii/firefly-iii/issues/2231) You can now also use the `DATABASE_URL` for MySQL connections.\n- [Issue 2291](https://github.com/firefly-iii/firefly-iii/issues/2291) All reports are now properly multi-currency.\n- [Issue 2481](https://github.com/firefly-iii/firefly-iii/issues/2481) As part of the removal of local encryption, uploads and imports are no longer encrypted.\n- [Issue 2495](https://github.com/firefly-iii/firefly-iii/issues/2495) A better message of transaction submission.\n- [Issue 2506](https://github.com/firefly-iii/firefly-iii/issues/2506) Some bugs in tag report fixed.\n- [Issue 2510](https://github.com/firefly-iii/firefly-iii/issues/2510) All transaction descriptions cut off at 255 chars.\n- Changing your language preference invites you to submit corrections to [Crowdin](https://crowdin.com/project/firefly-iii).\n- Better sum in bill view.\n- Clean up docker files for flawless operation.\n\n\n### Removed {#removed_13}\n- The bunq API has changed, and support for bunq has been disabled.\n\n\n### Fixed {#fixed_117}\n- [Issue 2470](https://github.com/firefly-iii/firefly-iii/issues/2470) Bad links for transactions.\n- [Issue 2480](https://github.com/firefly-iii/firefly-iii/issues/2480) Large queries would break in SQLite.\n- [Issue 2484](https://github.com/firefly-iii/firefly-iii/issues/2484) Transaction description auto-complete.\n- [Issue 2487](https://github.com/firefly-iii/firefly-iii/issues/2487) Fix issues with FinTS\n- [Issue 2488](https://github.com/firefly-iii/firefly-iii/issues/2488) 404 after deleting a tag.\n- [Issue 2490](https://github.com/firefly-iii/firefly-iii/issues/2490) \"Reset form after submission\" doesn't work.\n- [Issue 2492](https://github.com/firefly-iii/firefly-iii/issues/2492) After submitting and fixing an error, the error is persistent.\n- [Issue 2493](https://github.com/firefly-iii/firefly-iii/issues/2493) Auto detect transaction type is a bit better now.\n- [Issue 2498](https://github.com/firefly-iii/firefly-iii/issues/2498) Pressing enter in some fields breaks the form.\n- [Issue 2499](https://github.com/firefly-iii/firefly-iii/issues/2499) Auto-complete issues in transaction link form.\n- [Issue 2500](https://github.com/firefly-iii/firefly-iii/issues/2500) Issue when submitting edited transactions.\n- [Issue 2501](https://github.com/firefly-iii/firefly-iii/issues/2501) Better error messages for empty submissions.\n- [Issue 2508](https://github.com/firefly-iii/firefly-iii/issues/2508) Can remove category from transaction.\n- [Issue 2516](https://github.com/firefly-iii/firefly-iii/issues/2516) Can no longer import transactions with no amount.\n- [Issue 2518](https://github.com/firefly-iii/firefly-iii/issues/2518) Link in balance box goes to current period.\n- [Issue 2521](https://github.com/firefly-iii/firefly-iii/issues/2521) Foreign transaction currency is hidden when the user hasn't enabled foreign currencies.\n- [Issue 2522](https://github.com/firefly-iii/firefly-iii/issues/2522) Some reports were missing the \"overspent\" field.\n- [Issue 2526](https://github.com/firefly-iii/firefly-iii/issues/2526) It was impossible to remove the budget of a transaction.\n- [Issue 2527](https://github.com/firefly-iii/firefly-iii/issues/2527) Some bulk edits were buggy.\n- [Issue 2539](https://github.com/firefly-iii/firefly-iii/issues/2539) Fixed a typo.\n- [Issue 2545](https://github.com/firefly-iii/firefly-iii/issues/2545) Deleted tags would still show up.\n- [Issue 2547](https://github.com/firefly-iii/firefly-iii/issues/2547) Changing the opening balance to 0 will now remove it.\n- [Issue 2549](https://github.com/firefly-iii/firefly-iii/issues/2549) Can now clone transactions again.\n- [Issue 2550](https://github.com/firefly-iii/firefly-iii/issues/2550) Added missing locales for moment.js\n- [Issue 2553](https://github.com/firefly-iii/firefly-iii/issues/2553) Fixed an issue with split transactions.\n- [Issue 2555](https://github.com/firefly-iii/firefly-iii/issues/2555) Better error for when you submit the same account twice.\n- [Issue 2439](https://github.com/firefly-iii/firefly-iii/issues/2439) SQL error in API post new user\n- ... and many other bugs.\n\n\n### API {#api_41}\n- [Issue 2475](https://github.com/firefly-iii/firefly-iii/issues/2475) Tags are now the same for all views.\n- [Issue 2476](https://github.com/firefly-iii/firefly-iii/issues/2476) Amount is now represented equally in all views.\n- [Issue 2477](https://github.com/firefly-iii/firefly-iii/issues/2477) Rules are easier to update.\n- [Issue 2483](https://github.com/firefly-iii/firefly-iii/issues/2483) Several consistencies fixed.\n- [Issue 2484](https://github.com/firefly-iii/firefly-iii/issues/2484) Transaction link view fixed.\n- [Issue 2557](https://github.com/firefly-iii/firefly-iii/issues/2557) Fix for issue in summary API\n- No longer have to submit mandatory fields to account end point. Just submit the field you wish to update, the rest will be untouched.\n- Rules will no longer list the \"user-action\" trigger Rules will have a \"moment\" field that says either \"update-journal\" or \"store-journal\".\n\n\n## 4.8.0.3 (API 0.10.1) - 2019-08-23 {#4803-api-0101-2019-08-23}\n\n\nFixes many other issues in the previous release.\n\n\n### Added {#added_46}\n- Autocomplete for transaction description.\n\n\n### Fixed {#fixed_118}\n- [Issue 2438](https://github.com/firefly-iii/firefly-iii/issues/2438) Some balance issues when working with multiple currencies (a known issue)\n- [Issue 2425](https://github.com/firefly-iii/firefly-iii/issues/2425) Transaction edit/create form is weird with the enter button\n- [Issue 2424](https://github.com/firefly-iii/firefly-iii/issues/2424) auto complete tab doesn't work.\n- [Issue 2441](https://github.com/firefly-iii/firefly-iii/issues/2441) Inconsistent character limit for currencies.\n- [Issue 2443](https://github.com/firefly-iii/firefly-iii/issues/2443) 500 error when submitting budgets\n- [Issue 2446](https://github.com/firefly-iii/firefly-iii/issues/2446) Can't update current amount for piggy bank\n- [Issue 2440](https://github.com/firefly-iii/firefly-iii/issues/2440) Errors when interacting with recurring transactions\n- [Issue 2439](https://github.com/firefly-iii/firefly-iii/issues/2439) SQL error in API post new user\n- Transaction report (after import, over email) is mostly empty\n- Mass edit checkboxes doesn't work in a tag overview\n- [Issue 2437](https://github.com/firefly-iii/firefly-iii/issues/2437) CPU issues when viewing accounts, probably run-away queries.\n- [Issue 2432](https://github.com/firefly-iii/firefly-iii/issues/2432) Can't disable all currencies except one / can't disable EUR and switch to something else.\n- Option to edit the budget is gone from edit transaction form.\n- [Issue 2453](https://github.com/firefly-iii/firefly-iii/issues/2453) Search view things\n- [Issue 2449](https://github.com/firefly-iii/firefly-iii/issues/2449) Can't add invoice date.\n- [Issue 2448](https://github.com/firefly-iii/firefly-iii/issues/2448) Bad link in transaction overview\n- [Issue 2447](https://github.com/firefly-iii/firefly-iii/issues/2447) Bad link in bill overview\n\n\n### API {#api_42}\n- Improvements to various API end-points. Docs are updated.\n\n\n## 4.8.0.2 (API 0.10.0) - 2019-08-17 {#4802-api-0100-2019-08-17}\n\n\nFixes many other issues in the previous release.\n\n\n### Changed {#changed_50}\n- Make many report boxes multi-currency.\n\n\n### Fixed {#fixed_119}\n- [Issue 2203](https://github.com/firefly-iii/firefly-iii/issues/2203) Reconciliation inconsistencies.\n- [Issue 2392](https://github.com/firefly-iii/firefly-iii/issues/2392) Bad namespace leads to installation errors.\n- [Issue 2393](https://github.com/firefly-iii/firefly-iii/issues/2393) Missing budget selector.\n- [Issue 2402](https://github.com/firefly-iii/firefly-iii/issues/2402) bad amounts in default report\n- [Issue 2405](https://github.com/firefly-iii/firefly-iii/issues/2405) Due date can't be edited.\n- [Issue 2404](https://github.com/firefly-iii/firefly-iii/issues/2404) bad page indicator in the \"no category\" transaction overview.\n- [Issue 2407](https://github.com/firefly-iii/firefly-iii/issues/2407) Fix recurring transaction dates\n- [Issue 2410](https://github.com/firefly-iii/firefly-iii/issues/2410) Transaction links inconsistent\n- [Issue 2414](https://github.com/firefly-iii/firefly-iii/issues/2414) Can't edit recurring transactions\n- [Issue 2415](https://github.com/firefly-iii/firefly-iii/issues/2415) Return here + reset form results in empty transaction form\n- [Issue 2416](https://github.com/firefly-iii/firefly-iii/issues/2416) Some form inconsistencies.\n- [Issue 2418](https://github.com/firefly-iii/firefly-iii/issues/2418) Reports are inaccurate or broken.\n- [Issue 2422](https://github.com/firefly-iii/firefly-iii/issues/2422) PHP error when matching transactions.\n- [Issue 2423](https://github.com/firefly-iii/firefly-iii/issues/2423) Reports are inaccurate or broken.\n- [Issue 2426](https://github.com/firefly-iii/firefly-iii/issues/2426) Inconsistent documentation and instructions.\n- [Issue 2427](https://github.com/firefly-iii/firefly-iii/issues/2427) Deleted account and \"initial balance\" accounts may appear in dropdowns.\n- [Issue 2428](https://github.com/firefly-iii/firefly-iii/issues/2428) Reports are inaccurate or broken.\n- [Issue 2429](https://github.com/firefly-iii/firefly-iii/issues/2429) Typo leads to SQL errors in available budgets API\n- [Issue 2431](https://github.com/firefly-iii/firefly-iii/issues/2431) Issues creating new recurring transactions.\n- [Issue 2434](https://github.com/firefly-iii/firefly-iii/issues/2434) You can edit the initial balance transaction but it fails to save.\n- ARM build should work now.\n\n\n### API {#api_43}\n- [Issue 2429](https://github.com/firefly-iii/firefly-iii/issues/2429) Typo leads to SQL errors in available budgets API\n\n\n## 4.8.0.1 (API 0.10.0) - 2019-08-12 {#4801-api-0100-2019-08-12}\n\n\nFixes the most pressing issues found in the previous release.\n\n\n### Fixed {#fixed_120}\n- The balance box on the dashboard shows only negative numbers, skewing the results.\n- Selecting or using tags in new transactions results in an error.\n- Editing a transaction with tags will drop the tags from the transaction.\n- [Issue 2382](https://github.com/firefly-iii/firefly-iii/issues/2382) Ranger config\n- [Issue 2384](https://github.com/firefly-iii/firefly-iii/issues/2384) When upgrading manually, you may see: `The command \"generate-keys\" does not exist.`\n- [Issue 2385](https://github.com/firefly-iii/firefly-iii/issues/2385) When upgrading manually, the firefly:verify command may fail to run.\n- [Issue 2388](https://github.com/firefly-iii/firefly-iii/issues/2388) When registering as a new user, leaving the opening balance at 0 will give you an error.\n- [Issue 2395](https://github.com/firefly-iii/firefly-iii/issues/2395) Editing split transactions is broken.\n- [Issue 2397](https://github.com/firefly-iii/firefly-iii/issues/2397) Transfers are stored the wrong way around.\n- [Issue 2399](https://github.com/firefly-iii/firefly-iii/issues/2399) Not all account balances are updated after you create a new transaction.\n- [Issue 2401](https://github.com/firefly-iii/firefly-iii/issues/2401) Could not delete a split from a split transaction.\n\n\n## 4.8.0 (API 0.10.0) - 2019-08-09 {#480-api-0100-2019-08-09}\n\n\nA huge change that introduces significant database and API changes. Read more about it [in this Patreon post](https://www.patreon.com/posts/29044368).\n\n\n### Open and known issues {#open-and-known-issues}\n- The \"new transaction\"-form isn't translated.\n- You can't drag and drop transactions.\n- You can't clone transactions.\n\n\n### Added {#added_47}\n- Hungarian translation!\n\n\n### Changed {#changed_51}\n- New database model that changes the concept of \"split transactions\";\n- New installation routine with rewritten database integrity tests and upgrade code;\n- Rewritten screen to create transactions which will now completely rely on the API;\n- Most terminal commands now have the prefix `firefly-iii`.\n- New MFA code that will generate backup codes for you and is more robust. MFA will have to be re-enabled for ALL users.\n\n\n### Deprecated {#deprecated_8}\n- This will probably be the last Firefly III version to have import routines for files, Bunq and others. These will be moved to separate applications that use the Firefly III API.\n\n\n### Removed {#removed_14}\n- The export function has been removed.\n\n\n### Fixed {#fixed_121}\n- [Issue 1652](https://github.com/firefly-iii/firefly-iii/issues/1652), new strings to use during the import.\n- [Issue 1860](https://github.com/firefly-iii/firefly-iii/issues/1860), fixing the default currency not being on top in a JSON box.\n- [Issue 2031](https://github.com/firefly-iii/firefly-iii/issues/2031), a fix for Triodos imports.\n- [Issue 2153](https://github.com/firefly-iii/firefly-iii/issues/2153), problems with editing credit cards.\n- [Issue 2179](https://github.com/firefly-iii/firefly-iii/issues/2179), consistent and correct redirect behavior.\n- [Issue 2180](https://github.com/firefly-iii/firefly-iii/issues/2180), API issues with foreign amounts.\n- [Issue 2187](https://github.com/firefly-iii/firefly-iii/issues/2187), bulk editing reconciled transactions was broken.\n- [Issue 2188](https://github.com/firefly-iii/firefly-iii/issues/2188), redirect loop in bills\n- [Issue 2189](https://github.com/firefly-iii/firefly-iii/issues/2189), bulk edit could not handle tags.\n- [Issue 2203](https://github.com/firefly-iii/firefly-iii/issues/2203), [issue 2208](https://github.com/firefly-iii/firefly-iii/issues/2208), [issue 2352](https://github.com/firefly-iii/firefly-iii/issues/2352), reconciliation fixes\n- [Issue 2204](https://github.com/firefly-iii/firefly-iii/issues/2204), transaction type fix\n- [Issue 2211](https://github.com/firefly-iii/firefly-iii/issues/2211), mass edit fixes.\n- [Issue 2212](https://github.com/firefly-iii/firefly-iii/issues/2212), bug in the API when deleting objects.\n- [Issue 2214](https://github.com/firefly-iii/firefly-iii/issues/2214), could not view attachment.\n- [Issue 2219](https://github.com/firefly-iii/firefly-iii/issues/2219), max amount was a little low.\n- [Issue 2239](https://github.com/firefly-iii/firefly-iii/issues/2239), fixed ordering issue.\n- [Issue 2246](https://github.com/firefly-iii/firefly-iii/issues/2246), could not disable EUR.\n- [Issue 2268](https://github.com/firefly-iii/firefly-iii/issues/2268), could not import into liability accounts.\n- [Issue 2293](https://github.com/firefly-iii/firefly-iii/issues/2293), could not trigger rule on deposits in some circumstances\n- [Issue 2314](https://github.com/firefly-iii/firefly-iii/issues/2314), could not trigger rule on transfers in some circumstances\n- [Issue 2325](https://github.com/firefly-iii/firefly-iii/issues/2325), some balance issues on the frontpage.\n- [Issue 2328](https://github.com/firefly-iii/firefly-iii/issues/2328), some date range issues in reports\n- [Issue 2331](https://github.com/firefly-iii/firefly-iii/issues/2331), some broken fields in reports.\n- [Issue 2333](https://github.com/firefly-iii/firefly-iii/issues/2333), API issues with piggy banks.\n- [Issue 2355](https://github.com/firefly-iii/firefly-iii/issues/2355), configuration issues with LDAP\n- [Issue 2361](https://github.com/firefly-iii/firefly-iii/issues/2361), some ordering issues.\n\n\n### API {#api_44}\n- Updated API to reflect the changes in the database.\n- New API end-point for a summary of your data.\n- Some new API charts.\n\n\n## 4.7.17.6 (API 0.9.2) - 2019-08-02 {#47176-api-092-2019-08-02}\n\n\n\n### Security {#security_19}\n- XSS issue in liability account redirect, found by [@0x2500](https://github.com/0x2500).\n\n\n## 4.7.17.5 (API 0.9.2) - 2019-08-02 {#47175-api-092-2019-08-02}\n\n\n\n### Security {#security_20}\n- Several XSS issues, found by [@0x2500](https://github.com/0x2500).\n\n\n## 4.7.17.4 (API 0.9.2) - 2019-08-02 {#47174-api-092-2019-08-02}\n\n\n\n### Security {#security_21}\n- Several XSS issues, found by [@0x2500](https://github.com/0x2500).\n\n\n## 4.7.17.3 (API 0.9.2) - 2019-07-16 {#47173-api-092-2019-07-16}\n\n\n\n### Security {#security_22}\n- XSS bug in file uploads (x2), found by [@dayn1ne](https://github.com/dayn1ne).\n- XSS bug in search, found by [@dayn1ne](https://github.com/dayn1ne).\n\n\n## 4.7.17.2 (API 0.9.2) - 2019-07-15 {#47172-api-092-2019-07-15}\n\n\n\n### Security {#security_23}\n- XSS bug in budget title, found by [@dayn1ne](https://github.com/dayn1ne).\n\n\n## 4.7.17 (API 0.9.2) - 2019-03-17 {#4717-api-092-2019-03-17}\n\n\n\n### Added {#added_48}\n- Support for Norwegian!\n\n\n### Changed {#changed_52}\n- Clear cache during install routine.\n- Add Firefly III version number to install routine.\n\n\n### Removed {#removed_15}\n- Initial release.\n\n\n### Fixed {#fixed_122}\n- [Issue 2159](https://github.com/firefly-iii/firefly-iii/issues/2159) Bad redirect due to Laravel upgrade.\n- [Issue 2166](https://github.com/firefly-iii/firefly-iii/issues/2166) Importer had some issues with distinguishing double transfers.\n- [Issue 2167](https://github.com/firefly-iii/firefly-iii/issues/2167) New LDAP package gave some configuration changes.\n- [Issue 2173](https://github.com/firefly-iii/firefly-iii/issues/2173) Missing class when generating 2FA codes.\n\n\n## 4.7.16 (API 0.9.2) - 2019-03-08 {#4716-api-092-2019-03-08}\n\n\n4.7.16 was released to fix a persistent issue with broken user preferences.\n\n\n### Changed {#changed_53}\n\n\n- Firefly III now uses Laravel 5.8.\n\n\n## 4.7.15 (API 0.9.2) - 2019-03-02 {#4715-api-092-2019-03-02}\n\n\n4.7.15 was released to fix some issues upgrading from older versions.\n\n\n### Added {#added_49}\n- [Issue 2128](https://github.com/firefly-iii/firefly-iii/issues/2128) Support for Postgres SSL\n\n\n### Changed {#changed_54}\n- [Issue 2120](https://github.com/firefly-iii/firefly-iii/issues/2120) Add a missing meta tag, thanks to @lastlink\n- Search is a lot faster now.\n\n\n### Fixed {#fixed_123}\n- [Issue 2125](https://github.com/firefly-iii/firefly-iii/issues/2125) Decryption issues during upgrade\n- [Issue 2130](https://github.com/firefly-iii/firefly-iii/issues/2130) Fixed database migrations and rollbacks.\n- [Issue 2135](https://github.com/firefly-iii/firefly-iii/issues/2135) Date fixes in transaction overview\n\n\n## 4.7.14 (API 0.9.2) - 2019-02-24 {#4714-api-092-2019-02-24}\n\n\n4.7.14 was released to fix an issue with the Composer installation script.\n\n\n## 4.7.13 (API 0.9.2) - 2019-02-23 {#4713-api-092-2019-02-23}\n\n\n4.7.13 was released to fix an issue that affected the Softaculous build.\n\n\n### Added {#added_50}\n- A routine has been added that warns about transactions with a 0.00 amount.\n\n\n### Changed {#changed_55}\n- PHP maximum execution time is now 600 seconds in the Docker image.\n- Moved several files outside of the root of Firefly III\n\n\n### Fixed {#fixed_124}\n- Fix issue where missing preference breaks the database upgrade.\n- [Issue 2100](https://github.com/firefly-iii/firefly-iii/issues/2100) Mass edit transactions results in a reset of the date.\n\n\n## 4.7.12 (API 0.9.2) - 2019-02-16 {#4712-api-092-2019-02-16}\n\n\n4.7.12 was released to fix several shortcomings in v4.7.11's Docker image. Those in turn were caused by me. My apologies.\n\n\n### Changed {#changed_56}\n- [Issue 2085](https://github.com/firefly-iii/firefly-iii/issues/2085) Upgraded the LDAP code. To keep using LDAP, set the `LOGIN_PROVIDER` to `ldap`.\n\n\n### Fixed {#fixed_125}\n- [Issue 2061](https://github.com/firefly-iii/firefly-iii/issues/2061) Some users reported empty update popups.\n- [Issue 2070](https://github.com/firefly-iii/firefly-iii/issues/2070) A cache issue prevented rules from being applied correctly.\n- [Issue 2071](https://github.com/firefly-iii/firefly-iii/issues/2071) Several issues with Postgres and date values with time zone information in them.\n- [Issue 2081](https://github.com/firefly-iii/firefly-iii/issues/2081) Rules were not being applied when importing using FinTS.\n- [Issue 2082](https://github.com/firefly-iii/firefly-iii/issues/2082) The mass-editor changed all dates to today.\n\n\n## 4.7.11 (API 0.9.2) - 2019-02-10 {#4711-api-092-2019-02-10}\n\n### Added {#added_51}\n- Experimental audit logging channel to track important events (separate from debug logging).\n\n\n### Changed {#changed_57}\n- [Issue 2003](https://github.com/firefly-iii/firefly-iii/issues/2003), [issue 2006](https://github.com/firefly-iii/firefly-iii/issues/2006) Transactions can be stored with a timestamp. The user-interface does not support this yet. But the API does.\n- Docker image tags a new manifest for arm and amd64.\n\n\n### Removed {#removed_16}\n- [skuzzle](https://github.com/skuzzle) removed an annoying console.log statement.\n\n\n### Fixed {#fixed_126}\n- [Issue 2048](https://github.com/firefly-iii/firefly-iii/issues/2048) Fix \"Are you sure?\" popup, thanks to @nescafe2002!\n- [Issue 2049](https://github.com/firefly-iii/firefly-iii/issues/2049) Empty preferences would crash Firefly III.\n- [Issue 2052](https://github.com/firefly-iii/firefly-iii/issues/2052) Rules could not auto-covert to liabilities.\n- Webbased upgrade routine will also decrypt the database.\n- Last use date for categories was off.\n\n\n### API {#api_45}\n- The `date`-field in any transaction object now returns a ISO 8601 timestamp instead of a date.\n\n\n\n## 4.7.10 - 2019-02-03 {#4710-2019-02-03}\n\n### Added {#added_52}\n- [Issue 2037](https://github.com/firefly-iii/firefly-iii/issues/2037) Added some new magic keywords to reports.\n- Added a new currency exchange rate service, [ratesapi.io](https://ratesapi.io/), that does not require expensive API keys. Built by [@BoGnY](https://github.com/BoGnY).\n- Added Chinese Traditional translations. Thanks!\n\n\n### Changed {#changed_58}\n- [Issue 1977](https://github.com/firefly-iii/firefly-iii/issues/1977) Docker image now includes memcached support\n- [Issue 2031](https://github.com/firefly-iii/firefly-iii/issues/2031) A new generic debit/credit indicator for imports.\n- The new Docker image no longer has the capability to run cron jobs, and will no longer generate your recurring transactions for you. This has been done to simplify the build and make sure your Docker container runs one service, as it should. To set up a cron job for your new Docker container, [check out the documentation](https://docs.firefly-iii.org/en/latest/installation/cronjob.html).\n- Due to a change in the database structure, this upgrade will reset your preferences. Sorry about that.\n\n\n### Deprecated {#deprecated_9}\n- I will no longer accept PR's that introduce new currencies.\n\n\n### Removed {#removed_17}\n- Firefly III no longer encrypts the database and will [decrypt the database](https://github.com/firefly-iii/help/wiki/Database-encryption) on its first run.\n\n\n### Fixed {#fixed_127}\n- [Issue 1923](https://github.com/firefly-iii/firefly-iii/issues/1923) Broken window position for date picker.\n- [Issue 1967](https://github.com/firefly-iii/firefly-iii/issues/1967) Attachments were hidden in bill view.\n- [Issue 1927](https://github.com/firefly-iii/firefly-iii/issues/1927) It was impossible to make recurring transactions skip.\n- [Issue 1929](https://github.com/firefly-iii/firefly-iii/issues/1929) Fix the recurring transactions calendar overview.\n- [Issue 1933](https://github.com/firefly-iii/firefly-iii/issues/1933) Fixed a bug that made it impossible to authenticate to FreeIPA servers.\n- [Issue 1938](https://github.com/firefly-iii/firefly-iii/issues/1938) The importer can now handle the insane way Postbank (DE) formats its numbers.\n- [Issue 1942](https://github.com/firefly-iii/firefly-iii/issues/1942) Favicons are relative so Scriptaculous installations work better.\n- [Issue 1944](https://github.com/firefly-iii/firefly-iii/issues/1944) Make sure that the search allows you to mass-select transactions.\n- [Issue 1945](https://github.com/firefly-iii/firefly-iii/issues/1945) Slight UI change so the drop-down menu renders better.\n- [Issue 1955](https://github.com/firefly-iii/firefly-iii/issues/1955) Fixed a bug in the category report.\n- [Issue 1968](https://github.com/firefly-iii/firefly-iii/issues/1968) The yearly range would jump to 1-Jan / 1-Jan instead of 1-Jan / 31-Dec\n- [Issue 1975](https://github.com/firefly-iii/firefly-iii/issues/1975) Fixed explanation for missing credit card liabilities.\n- [Issue 1979](https://github.com/firefly-iii/firefly-iii/issues/1979) Make sure tags are trimmed.\n- [Issue 1983](https://github.com/firefly-iii/firefly-iii/issues/1983) Could not use your favorite decimal separator.\n- [Issue 1989](https://github.com/firefly-iii/firefly-iii/issues/1989) Bug in YNAB importer forced you to select all accounts.\n- [Issue 1990](https://github.com/firefly-iii/firefly-iii/issues/1990) Rule description was invisible in edit screen.\n- [Issue 1996](https://github.com/firefly-iii/firefly-iii/issues/1996) Deleted budget would inadvertently also hide transactions.\n- [Issue 2001](https://github.com/firefly-iii/firefly-iii/issues/2001) Various issues with tag chart view.\n- [Issue 2009](https://github.com/firefly-iii/firefly-iii/issues/2009) Could not change recurrence back to \"forever\".\n- [Issue 2033](https://github.com/firefly-iii/firefly-iii/issues/2033) Longitude can go from -180 to 180.\n- [Issue 2034](https://github.com/firefly-iii/firefly-iii/issues/2034) Rules were not being triggered in mass-edit.\n- [Issue 2043](https://github.com/firefly-iii/firefly-iii/issues/2043) In rare instances the repetition of a recurring transaction was displayed incorrectly.\n- Fixed broken translations in the recurring transactions overview.\n- When you create a recurring transfer you make make it fill (or empty) a piggy bank. This was not working, despite a fix in 4.7.8.\n- Fixed a bug where the importer would not be capable of creating new currencies.\n- Rule trigger tester would skip the amount.\n\n\n### Security {#security_24}\n- OAuth2 form can now submit back to original requester.\n\n\n### API (0.9.1) {#api-091}\n- Submitting transactions with a disabled currency will auto-enable the currency.\n- The documentation now states that \"Deposit\" is a possible return when you get a transaction.\n- \"savingAsset\" was incorrectly documented as \"savingsAsset\".\n- Account endpoint can now return type \"reconciliation\" and \"initial-balance\" correctly.\n- New API endpoint under `/summary/basic` that gives you a basic overview of the user's finances.\n- New API endpoints under `/chart/*` to allow you to render charts.\n- `/accounts/x/transactions` now supports the limit query parameter.\n- `/budgets/x/transactions` now supports the limit query parameter.\n- `/available_budgets` now supports custom start and end date parameters.\n- New endpoint `/preferences/prefName` to retrieve a single preference.\n- Added field `account_name` to all piggy banks.\n- New tag cloud in API.\n\n\nSee the [API docs](/api/) for more information.\n\n\n## 4.7.9 - 2018-12-25 {#479-2018-12-25}\n\n### Added {#added_53}\n- [Issue 1622](https://github.com/firefly-iii/firefly-iii/issues/1622) Can now unlink a transaction from a bill.\n- [Issue 1848](https://github.com/firefly-iii/firefly-iii/issues/1848) Added support for the Swiss Franc.\n\n\n### Changed {#changed_59}\n- [Issue 1828](https://github.com/firefly-iii/firefly-iii/issues/1828) Focus on fields for easy access.\n- [Issue 1859](https://github.com/firefly-iii/firefly-iii/issues/1859) Warning when seeding database.\n- Completely rewritten API. Check out the documentation [here](/api/).\n- Currencies can now be enabled and disabled, making for cleaner views.\n- You can disable the `X-Frame-Options` header if this is necessary.\n- New fancy favicons.\n- Updated and improved docker build.\n- Firefly III has been translated into Chinese (Traditional).\n\n\n\n### Removed {#removed_18}\n- Docker build no longer builds its own cURL.\n\n\n### Fixed {#fixed_128}\n- [Issue 1607](https://github.com/firefly-iii/firefly-iii/issues/1607) [issue 1857](https://github.com/firefly-iii/firefly-iii/issues/1857) [issue 1895](https://github.com/firefly-iii/firefly-iii/issues/1895) Improved bunq import and added support for auto-savings.\n- [Issue 1766](https://github.com/firefly-iii/firefly-iii/issues/1766) Extra commands so cache dir is owned by www user.\n- [Issue 1811](https://github.com/firefly-iii/firefly-iii/issues/1811) 404 when generating report without options.\n- [Issue 1835](https://github.com/firefly-iii/firefly-iii/issues/1835) Strange debug popup removed.\n- [Issue 1840](https://github.com/firefly-iii/firefly-iii/issues/1840) Error when exporting data.\n- [Issue 1857](https://github.com/firefly-iii/firefly-iii/issues/1857) Bunq import words again (see above).\n- [Issue 1858](https://github.com/firefly-iii/firefly-iii/issues/1858) SQL errors when importing CSV.\n- [Issue 1861](https://github.com/firefly-iii/firefly-iii/issues/1861) Period navigator was broken.\n- [Issue 1864](https://github.com/firefly-iii/firefly-iii/issues/1864) First description was empty on split transactions.\n- [Issue 1865](https://github.com/firefly-iii/firefly-iii/issues/1865) Bad math when showing categories.\n- [Issue 1868](https://github.com/firefly-iii/firefly-iii/issues/1868) Fixes to FinTS import.\n- [Issue 1872](https://github.com/firefly-iii/firefly-iii/issues/1872) Some images had 404's.\n- [Issue 1877](https://github.com/firefly-iii/firefly-iii/issues/1877) Several encryption / decryption issues.\n- [Issue 1878](https://github.com/firefly-iii/firefly-iii/issues/1878) Wrong nav links\n- [Issue 1884](https://github.com/firefly-iii/firefly-iii/issues/1884) Budget API improvements (see above)\n- [Issue 1888](https://github.com/firefly-iii/firefly-iii/issues/1888) Transaction API improvements (see above)\n- [Issue 1890](https://github.com/firefly-iii/firefly-iii/issues/1890) Fixes in Bills API\n- [Issue 1891](https://github.com/firefly-iii/firefly-iii/issues/1891) Typo fixed.\n- [Issue 1893](https://github.com/firefly-iii/firefly-iii/issues/1893) Update piggies from recurring transactions.\n- [Issue 1898](https://github.com/firefly-iii/firefly-iii/issues/1898) Bug in tag report.\n- [Issue 1901](https://github.com/firefly-iii/firefly-iii/issues/1901) Redirect when cloning transactions.\n- [Issue 1909](https://github.com/firefly-iii/firefly-iii/issues/1909) Date range fixes.\n- [Issue 1916](https://github.com/firefly-iii/firefly-iii/issues/1916) Date range fixes.\n\n\n## 4.7.8 - 2018-10-28 {#478-2018-10-28}\n\n### Added {#added_54}\n- [Issue 1005](https://github.com/firefly-iii/firefly-iii/issues/1005) You can now configure Firefly III to use LDAP.\n- [Issue 1071](https://github.com/firefly-iii/firefly-iii/issues/1071) You can execute transaction rules using the command line (so you can cronjob it)\n- [Issue 1108](https://github.com/firefly-iii/firefly-iii/issues/1108) You can now reorder budgets.\n- [Issue 1159](https://github.com/firefly-iii/firefly-iii/issues/1159) The ability to import transactions from FinTS-enabled banks.\n- [Issue 1727](https://github.com/firefly-iii/firefly-iii/issues/1727) You can now use SFTP as storage for uploads and exports.\n- [Issue 1733](https://github.com/firefly-iii/firefly-iii/issues/1733) You can configure Firefly III not to send emails with transaction information in them.\n\n\n\n\n### Changed {#changed_60}\n- [Issue 1040](https://github.com/firefly-iii/firefly-iii/issues/1040) Fixed various things that would not scale properly in the past.\n- [Issue 1771](https://github.com/firefly-iii/firefly-iii/issues/1771) A link to the transaction that fits the bill.\n- [Issue 1800](https://github.com/firefly-iii/firefly-iii/issues/1800) Icon updated to match others.\n- MySQL database connection now forces the InnoDB to be used.\n\n\n### Fixed {#fixed_129}\n- [Issue 1583](https://github.com/firefly-iii/firefly-iii/issues/1583) Some times recurring transactions would not fire.\n- [Issue 1607](https://github.com/firefly-iii/firefly-iii/issues/1607) Problems with the bunq API, finally solved?! (I feel like a clickbait YouTube video now)\n- [Issue 1698](https://github.com/firefly-iii/firefly-iii/issues/1698) Certificate problems in the Docker container\n- [Issue 1751](https://github.com/firefly-iii/firefly-iii/issues/1751) Bug in autocomplete\n- [Issue 1760](https://github.com/firefly-iii/firefly-iii/issues/1760) Tag report bad math\n- [Issue 1765](https://github.com/firefly-iii/firefly-iii/issues/1765) API inconsistencies for piggy banks.\n- [Issue 1774](https://github.com/firefly-iii/firefly-iii/issues/1774) Integer exception in SQLite databases\n- [Issue 1775](https://github.com/firefly-iii/firefly-iii/issues/1775) Heroku now supports all locales\n- [Issue 1778](https://github.com/firefly-iii/firefly-iii/issues/1778) More autocomplete problems fixed\n- [Issue 1747](https://github.com/firefly-iii/firefly-iii/issues/1747) Rules now stop at the right moment.\n- [Issue 1781](https://github.com/firefly-iii/firefly-iii/issues/1781) Problems when creating new rules.\n- [Issue 1784](https://github.com/firefly-iii/firefly-iii/issues/1784) Can now create a liability with an empty balance.\n- [Issue 1785](https://github.com/firefly-iii/firefly-iii/issues/1785) Redirect error\n- [Issue 1790](https://github.com/firefly-iii/firefly-iii/issues/1790) Show attachments for bills.\n- [Issue 1792](https://github.com/firefly-iii/firefly-iii/issues/1792) Mention excluded accounts.\n- [Issue 1798](https://github.com/firefly-iii/firefly-iii/issues/1798) Could not recreate deleted piggy banks\n- [Issue 1805](https://github.com/firefly-iii/firefly-iii/issues/1805) Fixes when handling foreign currencies\n- [Issue 1807](https://github.com/firefly-iii/firefly-iii/issues/1807) Also decrypt deleted records.\n- [Issue 1812](https://github.com/firefly-iii/firefly-iii/issues/1812) Fix in transactions API\n- [Issue 1815](https://github.com/firefly-iii/firefly-iii/issues/1815) Opening balance account name can now be translated.\n- [Issue 1830](https://github.com/firefly-iii/firefly-iii/issues/1830) Multi-user in a single browser could leak autocomplete data.\n\n\n## 4.7.7 - 2018-10-01 {#477-2018-10-01}\n\n\nThis version of Firefly III requires PHP 7.2. I've already started using several features from 7.2. Please make sure you upgrade.\n\n\n### Added {#added_55}\n- [Issue 954](https://github.com/firefly-iii/firefly-iii/issues/954) Some additional view chart ranges\n- [Issue 1710](https://github.com/firefly-iii/firefly-iii/issues/1710) Added a new currency ([hamuz](https://github.com/hamuz))\n- Transactions will now store (in the database) how they were created.\n\n\n### Changed {#changed_61}\n- [Issue 907](https://github.com/firefly-iii/firefly-iii/issues/907) Better and more options on the transaction list.\n- [Issue 1450](https://github.com/firefly-iii/firefly-iii/issues/1450) Add a rule to change the type of a transaction automagically\n- [Issue 1701](https://github.com/firefly-iii/firefly-iii/issues/1701) Fix reference to PHP executable ([hertzg](https://github.com/hertzg))\n- Budget limits have currency information, for future expansion.\n- Some charts and pages can handle multiple currencies better.\n- New GA code for those who use it.\n\n\n### Removed {#removed_19}\n- The credit card liability type has been removed.\n\n\n### Fixed {#fixed_130}\n- [Issue 896](https://github.com/firefly-iii/firefly-iii/issues/896) Better redirection when coming from deleted objects.\n- [Issue 1519](https://github.com/firefly-iii/firefly-iii/issues/1519) Fix autocomplete tags\n- [Issue 1607](https://github.com/firefly-iii/firefly-iii/issues/1607) Some fixes for the bunq api calls\n- [Issue 1650](https://github.com/firefly-iii/firefly-iii/issues/1650) Add a negated amount column for CSV imports ([hamuz](https://github.com/hamuz))\n- [Issue 1658](https://github.com/firefly-iii/firefly-iii/issues/1658) Make font heavy again.\n- [Issue 1660](https://github.com/firefly-iii/firefly-iii/issues/1660) Add a negated amount column for CSV imports ([hamuz](https://github.com/hamuz))\n- [Issue 1667](https://github.com/firefly-iii/firefly-iii/issues/1667) Fix pie charts\n- [Issue 1668](https://github.com/firefly-iii/firefly-iii/issues/1668) YNAB iso_code fix\n- [Issue 1670](https://github.com/firefly-iii/firefly-iii/issues/1670) Fix piggy bank API error\n- [Issue 1671](https://github.com/firefly-iii/firefly-iii/issues/1671) More options for liability accounts.\n- [Issue 1673](https://github.com/firefly-iii/firefly-iii/issues/1673) Fix reconciliation issues.\n- [Issue 1675](https://github.com/firefly-iii/firefly-iii/issues/1675) Wrong sum in tag report.\n- [Issue 1679](https://github.com/firefly-iii/firefly-iii/issues/1679) Change type of a transaction wouldn't trigger rules.\n- [Issue 1682](https://github.com/firefly-iii/firefly-iii/issues/1682) Add liability accounts to transaction conversion\n- [Issue 1683](https://github.com/firefly-iii/firefly-iii/issues/1683) See matching transaction showed transfers twice.\n- [Issue 1685](https://github.com/firefly-iii/firefly-iii/issues/1685) fix autocomplete for rules\n- [Issue 1690](https://github.com/firefly-iii/firefly-iii/issues/1690) Missing highlighted button in intro popup\n- [Issue 1691](https://github.com/firefly-iii/firefly-iii/issues/1691) No mention of liabilities in demo text\n- [Issue 1695](https://github.com/firefly-iii/firefly-iii/issues/1695) Small fixes in bills pages.\n- [Issue 1708](https://github.com/firefly-iii/firefly-iii/issues/1708) Fix by [mathieupost](https://github.com/mathieupost) for bunq\n- [Issue 1709](https://github.com/firefly-iii/firefly-iii/issues/1709) Fix oauth buttons\n- [Issue 1712](https://github.com/firefly-iii/firefly-iii/issues/1712) Double slash fix by [hamuz](https://github.com/hamuz)\n- [Issue 1719](https://github.com/firefly-iii/firefly-iii/issues/1719) Add missing accounts to API\n- [Issue 1720](https://github.com/firefly-iii/firefly-iii/issues/1720) Fix validation for transaction type.\n- [Issue 1723](https://github.com/firefly-iii/firefly-iii/issues/1723) API broken for currency exchange rates.\n- [Issue 1728](https://github.com/firefly-iii/firefly-iii/issues/1728) Fix problem with transaction factory.\n- [Issue 1729](https://github.com/firefly-iii/firefly-iii/issues/1729) Fix bulk transaction editor\n- [Issue 1731](https://github.com/firefly-iii/firefly-iii/issues/1731) API failure for budget limits.\n\n\n### Security {#security_25}\n- Secure headers now allow Mapbox and the 2FA QR code.\n\n\n## 4.7.6.2 - 2018-09-03 {#4762-2018-09-03}\n\n### Fixed {#fixed_131}\n- Docker file builds again.\n- Fix CSS of OAuth2 authorization view.\n\n\n## 4.7.6.1 - 2018-09-02 {#4761-2018-09-02}\n\n### Fixed {#fixed_132}\n- An issue where I switched variables from the Docker `.env` file to the normal `.env` file and vice versa -- breaking both.\n- [Issue 1649](https://github.com/firefly-iii/firefly-iii/issues/1649) 2FA QR code would not show up due to very strict security policy headers\n- Docker build gave a cURL error whenever it runs PHP commands.\n\n\n## 4.7.6 - 2018-09-02 {#476-2018-09-02}\n\n### Added {#added_56}\n- [Issue 145](https://github.com/firefly-iii/firefly-iii/issues/145) You can now download transactions from YNAB.\n- [Issue 306](https://github.com/firefly-iii/firefly-iii/issues/306) You can now add liabilities to Firefly III.\n- [Issue 740](https://github.com/firefly-iii/firefly-iii/issues/740) Various charts are now currency aware.\n- [Issue 833](https://github.com/firefly-iii/firefly-iii/issues/833) Bills can use non-default currencies.\n- [Issue 1578](https://github.com/firefly-iii/firefly-iii/issues/1578) Firefly III will notify you if the cron job hasn't fired.\n- [Issue 1623](https://github.com/firefly-iii/firefly-iii/issues/1623) New transactions will link back from the success message.\n- [Issue 1624](https://github.com/firefly-iii/firefly-iii/issues/1624) transactions will link to the object.\n- You can call the cron job over the web now (see docs).\n- You don't need to call the cron job every minute any more.\n- Various charts are now red/green to signify income and expenses.\n- Option to add or remove accounts from the net worth calculations.\n\n\n### Deprecated {#deprecated_10}\n- This will be the last release on PHP 7.1. Future versions will require PHP 7.2.\n\n\n### Fixed {#fixed_133}\n- [Issue 1460](https://github.com/firefly-iii/firefly-iii/issues/1460) Downloading transactions from bunq should go more smoothly.\n- [Issue 1464](https://github.com/firefly-iii/firefly-iii/issues/1464) Fixed the docker file to work on Raspberry Pi's.\n- [Issue 1540](https://github.com/firefly-iii/firefly-iii/issues/1540) The Docker file now has a working cron job for recurring transactions.\n- [Issue 1564](https://github.com/firefly-iii/firefly-iii/issues/1564) Fix double transfers when importing from bunq.\n- [Issue 1575](https://github.com/firefly-iii/firefly-iii/issues/1575) Some views would give a XSRF token warning\n- [Issue 1576](https://github.com/firefly-iii/firefly-iii/issues/1576) Fix assigning budgets\n- [Issue 1580](https://github.com/firefly-iii/firefly-iii/issues/1580) Missing string for translation\n- [Issue 1581](https://github.com/firefly-iii/firefly-iii/issues/1581) Expand help text\n- [Issue 1584](https://github.com/firefly-iii/firefly-iii/issues/1584) Link to administration is back.\n- [Issue 1586](https://github.com/firefly-iii/firefly-iii/issues/1586) Date fields in import were mislabeled.\n- [Issue 1593](https://github.com/firefly-iii/firefly-iii/issues/1593) Link types are translatable.\n- [Issue 1594](https://github.com/firefly-iii/firefly-iii/issues/1594) Very long breadcrumbs are weird.\n- [Issue 1598](https://github.com/firefly-iii/firefly-iii/issues/1598) Fix budget calculations.\n- [Issue 1597](https://github.com/firefly-iii/firefly-iii/issues/1597) Piggy banks are always inactive.\n- [Issue 1605](https://github.com/firefly-iii/firefly-iii/issues/1605) System will ignore foreign currency setting if user doesn't indicate the amount.\n- [Issue 1608](https://github.com/firefly-iii/firefly-iii/issues/1608) Spelling error in command line import.\n- [Issue 1609](https://github.com/firefly-iii/firefly-iii/issues/1609) Link to budgets page was absolute.\n- [Issue 1615](https://github.com/firefly-iii/firefly-iii/issues/1615) Fix currency bug in transactions.\n- [Issue 1616](https://github.com/firefly-iii/firefly-iii/issues/1616) Fix null pointer exception in pie charts.\n- [Issue 1617](https://github.com/firefly-iii/firefly-iii/issues/1617) Fix for complex tag names in URL's.\n- [Issue 1620](https://github.com/firefly-iii/firefly-iii/issues/1620) Fixed index reference in API.\n- [Issue 1639](https://github.com/firefly-iii/firefly-iii/issues/1639) Firefly III trusts the Heroku load balancer, fixing deployment on Heroku.\n- [Issue 1642](https://github.com/firefly-iii/firefly-iii/issues/1642) Fix issue with split journals.\n- [Issue 1643](https://github.com/firefly-iii/firefly-iii/issues/1643) Fix reconciliation issue.\n- Users can no longer give income a budget.\n- Fix bug in Spectre import.\n- Heroku would not make you owner.\n- The rule \"tester\" will now also take the \"strict\"-checkbox into account.\n\n\n### Security {#security_26}\n- Add `.htaccess` files to all public directories.\n- New secure headers will make Firefly III slightly more secure.\n\n\n## 4.7.5.3 - 2017-07-28 {#4753-2017-07-28}\n\n### Added {#added_57}\n- Many updated French translations thanks to [@bubka](https://crowdin.com/profile/bubka).\n\n\n### Fixed {#fixed_134}\n- [Issue 1527](https://github.com/firefly-iii/firefly-iii/issues/1527), fixed views for transactions without a budget.\n- [Issue 1553](https://github.com/firefly-iii/firefly-iii/issues/1553), report could not handle transactions before the first one in the system.\n- [Issue 1549](https://github.com/firefly-iii/firefly-iii/issues/1549) update a budget will also update any rules that refer to that budget.\n- [Issue 1530](https://github.com/firefly-iii/firefly-iii/issues/1530), fix issue with bill chart.\n- [Issue 1563](https://github.com/firefly-iii/firefly-iii/issues/1563), fix piggy bank suggested amount\n- [Issue 1571](https://github.com/firefly-iii/firefly-iii/issues/1571), fix OAuth in Sandstorm\n- [Issue 1568](https://github.com/firefly-iii/firefly-iii/issues/1568), bug in Sandstorm user code.\n- [Issue 1569](https://github.com/firefly-iii/firefly-iii/issues/1569), optimized Sandstorm build by [ocdtrekkie](https://github.com/ocdtrekkie)\n- Fixed a bug where transfers would be stored inversely when using the CSV import.\n- Retired the \"Rabobank description\"-fix, because it is no longer necessary.\n- Fixed a bug where users could not delete budget limits in the API.\n- Piggy bank notes are visible again.\n\n\n## 4.7.5.2 - 2017-07-28 {#4752-2017-07-28}\nThis version was superseeded by v4.7.5.3 because of a critical bug in the proxy-middleware.\n\n\n## 4.7.5.1 - 2018-07-14 {#4751-2018-07-14}\n\n### Fixed {#fixed_135}\n- [Issue 1531](https://github.com/firefly-iii/firefly-iii/issues/1531), the database routine incorrectly reports empty categories.\n- [Issue 1532](https://github.com/firefly-iii/firefly-iii/issues/1532), broken dropdown for autosuggest things.\n- [Issue 1533](https://github.com/firefly-iii/firefly-iii/issues/1533), fix where the import could not import category names.\n- [Issue 1538](https://github.com/firefly-iii/firefly-iii/issues/1538), fix a bug where Spectre would not work when ignoring rules.\n- [Issue 1542](https://github.com/firefly-iii/firefly-iii/issues/1542), fix a bug where the importer was incapable of generating new currencies.\n- [Issue 1541](https://github.com/firefly-iii/firefly-iii/issues/1541), no longer ignore composer.lock in Docker ignore.\n- Bills are stored inactive.\n\n\n## 4.7.5 - 2018-07-02 {#475-2018-07-02}\n\n### Added {#added_58}\n- A new feature called \"recurring transactions\" that will make Firefly III automatically create transactions for you.\n- New API end points for attachments, available budgets, budgets, budget limits, categories, configuration, currency exchange rates, journal links, link types, piggy banks, preferences, recurring transactions, rules, rule groups and tags.\n- Added support for YunoHost.\n\n\n### Changed {#changed_62}\n- The 2FA secret is visible so you can type it into 2FA apps.\n- Bunq and Spectre imports will now ask to apply rules.\n- Sandstorm users can now make API keys.\n\n\n### Fixed {#fixed_136}\n- Various typo's in the English translations. [issue 1493](https://github.com/firefly-iii/firefly-iii/issues/1493)\n- Bug where Spectre was never called [issue 1492](https://github.com/firefly-iii/firefly-iii/issues/1492)\n- Clear cache after journal is created through API [issue 1483](https://github.com/firefly-iii/firefly-iii/issues/1483)\n- Make sure docker directories exist [issue 1500](https://github.com/firefly-iii/firefly-iii/issues/1500)\n- Broken link to bill edit [issue 1505](https://github.com/firefly-iii/firefly-iii/issues/1505)\n- Several bugs in the editing of split transactions [issue 1509](https://github.com/firefly-iii/firefly-iii/issues/1509)\n- Import routine ignored formatting of several date fields [issue 1510](https://github.com/firefly-iii/firefly-iii/issues/1510)\n- Piggy bank events now show the correct currency [issue 1446](https://github.com/firefly-iii/firefly-iii/issues/1446)\n- Inactive accounts are no longer suggested [issue 1463](https://github.com/firefly-iii/firefly-iii/issues/1463)\n- Some income / expense charts are less confusing [issue 1518](https://github.com/firefly-iii/firefly-iii/issues/1518)\n- Validation bug in multi-currency create view [issue 1521](https://github.com/firefly-iii/firefly-iii/issues/1521)\n- Bug where imported transfers would be stored incorrectly.\n\n\n## 4.7.4] - 2015-06-03 {#474-2015-06-03}\n\n### Added {#added_59}\n- [Issue 1409](https://github.com/firefly-iii/firefly-iii/issues/1409), add Indian Rupee and explain that users can do this themselves [issue 1413](https://github.com/firefly-iii/firefly-iii/issues/1413)\n- [Issue 1445](https://github.com/firefly-iii/firefly-iii/issues/1445), upgrade Curl in Docker image.\n- [Issue 1386](https://github.com/firefly-iii/firefly-iii/issues/1386), quick links to often used pages.\n- [Issue 1405](https://github.com/firefly-iii/firefly-iii/issues/1405), show proposed amount to piggy banks.\n- [Issue 1416](https://github.com/firefly-iii/firefly-iii/issues/1416), ability to delete lost attachments.\n\n\n### Changed {#changed_63}\n- A completely rewritten import routine that can handle bunq (thanks everybody for testing!), CSV files and Spectre. Please make sure you read about this at http://bit.ly/FF3-new-import\n- [Issue 1392](https://github.com/firefly-iii/firefly-iii/issues/1392), explicitly mention rules are inactive (when they are).\n- [Issue 1406](https://github.com/firefly-iii/firefly-iii/issues/1406), bill conversion to rules will be smarter about the rules they create.\n\n\n### Fixed {#fixed_137}\n- [Issue 1369](https://github.com/firefly-iii/firefly-iii/issues/1369), you can now properly order piggy banks again.\n- [Issue 1389](https://github.com/firefly-iii/firefly-iii/issues/1389), null-pointer in the import routine.\n- [Issue 1400](https://github.com/firefly-iii/firefly-iii/issues/1400), missing translation.\n- [Issue 1403](https://github.com/firefly-iii/firefly-iii/issues/1403), bill would always be marked as inactive in edit screen.\n- [Issue 1418](https://github.com/firefly-iii/firefly-iii/issues/1418), missing note text on bill page.\n- Export routine would break when encountering un-decryptable files.\n- [Issue 1425](https://github.com/firefly-iii/firefly-iii/issues/1425), empty fields when edit multiple transactions at once.\n- [Issue 1449](https://github.com/firefly-iii/firefly-iii/issues/1449), bad calculations in \"budget left to spend\" view.\n- [Issue 1451](https://github.com/firefly-iii/firefly-iii/issues/1451), same but in another view.\n- [Issue 1453](https://github.com/firefly-iii/firefly-iii/issues/1453), same as [issue 1403](https://github.com/firefly-iii/firefly-iii/issues/1403).\n- [Issue 1455](https://github.com/firefly-iii/firefly-iii/issues/1455), could add income to a budget.\n- [Issue 1442](https://github.com/firefly-iii/firefly-iii/issues/1442), issues with editing a split deposit.\n- [Issue 1452](https://github.com/firefly-iii/firefly-iii/issues/1452), date range problems with tags.\n- [Issue 1458](https://github.com/firefly-iii/firefly-iii/issues/1458), same for transactions.\n- [Issue 2956](https://github.com/firefly-iii/firefly-iii/issues/2956) Switch start and end date automagically when end is before start.\n- [Issue 2975](https://github.com/firefly-iii/firefly-iii/issues/2975) Division by zero.\n- [Issue 2966](https://github.com/firefly-iii/firefly-iii/issues/2966) Could not render description auto-complete.\n- [Issue 2976](https://github.com/firefly-iii/firefly-iii/issues/2976) Make budget dropdown in the same order as the budget list.\n\n\n\n### Security {#security_27}\n- [Issue 1415](https://github.com/firefly-iii/firefly-iii/issues/1415), will email you when OAuth2 keys are generated.\n\n\n## 4.7.3.2 - 2018-05-16 {#4732-2018-05-16}\n\n### Fixed {#fixed_138}\n- Forgot to increase the version number :(.\n\n\n\n## 4.7.3.1 - 2018-05-14 {#4731-2018-05-14}\n\n### Fixed {#fixed_139}\n- Fixed a critical bug where the rules-engine would fire inadvertently.\n\n\n## 4.7.3 - 2018-04-29 {#473-2018-04-29}\n\n### Added {#added_60}\n- Currency added to API\n- Firfely III will also generate a cash wallet for new users.\n- Can now reset Spectre and bunq settings\n- Docker file has a time zone\n- Allow database connection to be configured in Docker file\n- Can now view and edit attachments in edit-screen\n- User can visit hidden `/attachments` page\n- [Issue 1356](https://github.com/firefly-iii/firefly-iii/issues/1356): Budgets will show the remaining amount per day\n- [Issue 1367](https://github.com/firefly-iii/firefly-iii/issues/1367): Rules now come in strict and non-strict mode.\n- Added a security.txt\n- More support for trusted proxies\n\n\n### Changed {#changed_64}\n- Improved edit routine for split transactions.\n- Upgrade routine can handle `proc_close` being disabled.\n- Bills now use rules to match transactions, making it more flexible.\n- [Issue 1328](https://github.com/firefly-iii/firefly-iii/issues/1328): piggy banks no have a more useful chart.\n- Spectre API upgraded to v4\n- Move to MariaDB ([issue 1366](https://github.com/firefly-iii/firefly-iii/issues/1366))\n- Piggy banks take currency from parent account ([issue 1334](https://github.com/firefly-iii/firefly-iii/issues/1334))\n\n\n### Deprecated {#deprecated_11}\n- [Issue 1341](https://github.com/firefly-iii/firefly-iii/issues/1341): Removed depricated command from dockerfile\n\n\n### Fixed {#fixed_140}\n- Several issues with docker image ([issue 1320](https://github.com/firefly-iii/firefly-iii/issues/1320), [issue 1382](https://github.com/firefly-iii/firefly-iii/issues/1382)).\n- Fix giant tags and division by zero ([issue 1325](https://github.com/firefly-iii/firefly-iii/issues/1325) and others)\n- Several issues with bunq import ([issue 1352](https://github.com/firefly-iii/firefly-iii/issues/1352), [issue 1330](https://github.com/firefly-iii/firefly-iii/issues/1330), [issue 1378](https://github.com/firefly-iii/firefly-iii/issues/1378), [issue 1380](https://github.com/firefly-iii/firefly-iii/issues/1380))\n- [Issue 1246](https://github.com/firefly-iii/firefly-iii/issues/1246): date picker is internationalised\n- [Issue 1327](https://github.com/firefly-iii/firefly-iii/issues/1327): fix formattting issues in piggy banks\n- [Issue 1348](https://github.com/firefly-iii/firefly-iii/issues/1348): 500 error in API\n- [Issue 1349](https://github.com/firefly-iii/firefly-iii/issues/1349): Errors in import routine\n- Several fixes for (multi-currency) reconciliation ([issue 1336](https://github.com/firefly-iii/firefly-iii/issues/1336), [issue 1363](https://github.com/firefly-iii/firefly-iii/issues/1363))\n- [Issue 1353](https://github.com/firefly-iii/firefly-iii/issues/1353): return NULL values in range-indicator\n\n\n## 4.7.2.2 - 2018-04-04 {#4722-2018-04-04}\n\n### Fixed {#fixed_141}\n- Bug in split transaction edit routine\n- Piggy bank percentage was very specific.\n- Logging in Slack is easier to config.\n- [Issue 1312](https://github.com/firefly-iii/firefly-iii/issues/1312) Import broken for ING accounts\n- [Issue 1313](https://github.com/firefly-iii/firefly-iii/issues/1313) Error when creating new asset account\n- [Issue 1317](https://github.com/firefly-iii/firefly-iii/issues/1317) Forgot an include :(\n\n\n## 4.7.2.1 - 2018-04-02 {#4721-2018-04-02}\n\n### Fixed {#fixed_142}\n- Null pointer exception in transaction overview.\n- Installations running in subdirs were incapable of creating OAuth tokens.\n- OAuth keys were not created in all cases.\n\n\n## 4.7.2 - 2018-04-01 {#472-2018-04-01}\n\n### Added {#added_61}\n- [Issue 1123](https://github.com/firefly-iii/firefly-iii/issues/1123) First browser based update routine.\n- Add support for Italian.\n- [Issue 1232](https://github.com/firefly-iii/firefly-iii/issues/1232) Allow user to specify Docker database port.\n- [Issue 1197](https://github.com/firefly-iii/firefly-iii/issues/1197) Beter account list overview\n- [Issue 1202](https://github.com/firefly-iii/firefly-iii/issues/1202) Some budgetary warnings\n- [Issue 1284](https://github.com/firefly-iii/firefly-iii/issues/1284) Experimental support for bunq import\n- [Issue 1248](https://github.com/firefly-iii/firefly-iii/issues/1248) Ability to import BIC, ability to import SEPA fields.\n- [Issue 1102](https://github.com/firefly-iii/firefly-iii/issues/1102) Summary line for bills\n- More info to debug page.\n- [Issue 1186](https://github.com/firefly-iii/firefly-iii/issues/1186) You can see the latest account balance in CRUD forms\n- Add Kubernetes YAML files, kindly created by a FF3 user.\n\n\n### Changed {#changed_65}\n- [Issue 1244](https://github.com/firefly-iii/firefly-iii/issues/1244) Better line for \"today\" marker and add it to other chart as well ([issue 1214](https://github.com/firefly-iii/firefly-iii/issues/1214))\n- [Issue 1219](https://github.com/firefly-iii/firefly-iii/issues/1219) Languages in dropdown\n- [Issue 1189](https://github.com/firefly-iii/firefly-iii/issues/1189) Inactive accounts get removed from net worth\n- [Issue 1220](https://github.com/firefly-iii/firefly-iii/issues/1220) Attachment description and notes migrated to just \"notes\".\n- [Issue 1236](https://github.com/firefly-iii/firefly-iii/issues/1236) Multi currency balance box\n- [Issue 1240](https://github.com/firefly-iii/firefly-iii/issues/1240) Better overview for accounts.\n- [Issue 1292](https://github.com/firefly-iii/firefly-iii/issues/1292) Removed some charts from the \"all\"-overview of budgets and categories\n- [Issue 1245](https://github.com/firefly-iii/firefly-iii/issues/1245) Improved recognition of IBANs\n- Improved import routine.\n- Update notifier will wait three days before notifying users.\n- [Issue 1300](https://github.com/firefly-iii/firefly-iii/issues/1300) Virtual balance of credit cards does not count for net worth\n- [Issue 1247](https://github.com/firefly-iii/firefly-iii/issues/1247) Can now see overspent amount\n- [Issue 1221](https://github.com/firefly-iii/firefly-iii/issues/1221) Upgrade to Laravel 5.6\n- [Issue 1187](https://github.com/firefly-iii/firefly-iii/issues/1187) Updated the password verifier to use Troy Hunt's new API\n- Revenue chart is now on frontpage permanently\n- [Issue 1153](https://github.com/firefly-iii/firefly-iii/issues/1153) 2FA settings are in your profile now\n- [Issue 1227](https://github.com/firefly-iii/firefly-iii/issues/1227) Can set the timezone in config or in Docker\n\n\n### Fixed {#fixed_143}\n- [Issue 1294](https://github.com/firefly-iii/firefly-iii/issues/1294) Ability to link a transaction to itself\n- Correct reference to journal description in split form.\n- [Issue 1234](https://github.com/firefly-iii/firefly-iii/issues/1234) Fix budget page issues in SQLite\n- [Issue 1262](https://github.com/firefly-iii/firefly-iii/issues/1262) Can now use double and epty headers in CSV files\n- [Issue 1258](https://github.com/firefly-iii/firefly-iii/issues/1258) Fixed a possible date mismatch in piggy banks\n- [Issue 1283](https://github.com/firefly-iii/firefly-iii/issues/1283) Bulk delete was broken\n- [Issue 1293](https://github.com/firefly-iii/firefly-iii/issues/1293) Layout problem with notes\n- [Issue 1257](https://github.com/firefly-iii/firefly-iii/issues/1257) Improve transaction lists query count\n- [Issue 1291](https://github.com/firefly-iii/firefly-iii/issues/1291) Fixer IO problems\n- [Issue 1239](https://github.com/firefly-iii/firefly-iii/issues/1239) Could not edit expense or revenue accounts ([issue 1298](https://github.com/firefly-iii/firefly-iii/issues/1298))\n- [Issue 1297](https://github.com/firefly-iii/firefly-iii/issues/1297) Could not convert to withdrawal\n- [Issue 1226](https://github.com/firefly-iii/firefly-iii/issues/1226) Category overview in default report shows no income.\n- Various other bugs and problems ([issue 1198](https://github.com/firefly-iii/firefly-iii/issues/1198), [issue 1213](https://github.com/firefly-iii/firefly-iii/issues/1213), [issue 1237](https://github.com/firefly-iii/firefly-iii/issues/1237), [issue 1238](https://github.com/firefly-iii/firefly-iii/issues/1238), [issue 1199](https://github.com/firefly-iii/firefly-iii/issues/1199), [issue 1200](https://github.com/firefly-iii/firefly-iii/issues/1200))\n\n\n### Security {#security_28}\n- Fixed an issue with token validation on the command line.\n\n\n## 4.7.1 - 2018-03-04 {#471-2018-03-04}\n\n### Added {#added_62}\n- A brand new API. Read about it in the [documentation](http://firefly-iii.readthedocs.io/en/latest/).\n- Add support for Spanish. [issue 1194](https://github.com/firefly-iii/firefly-iii/issues/1194)\n- Some custom preferences are selected by default for a better user experience.\n- Some new currencies [issue 1211](https://github.com/firefly-iii/firefly-iii/issues/1211)\n\n\n### Fixed {#fixed_144}\n- Fixed [issue 1155](https://github.com/firefly-iii/firefly-iii/issues/1155) (reported by [ndandanov](https://github.com/ndandanov))\n- [Issue 1156](https://github.com/firefly-iii/firefly-iii/issues/1156) [issue 1182](https://github.com/firefly-iii/firefly-iii/issues/1182) and other issues related to SQLite databases.\n- Multi-page budget overview was broken (reported by [jinformatique](https://github.com/jinformatique))\n- Importing CSV files with semi-colons in them did not work [issue 1172](https://github.com/firefly-iii/firefly-iii/issues/1172) [issue 1183](https://github.com/firefly-iii/firefly-iii/issues/1183) [issue 1210](https://github.com/firefly-iii/firefly-iii/issues/1210)\n- Could not use account number that was in use by a deleted account [issue 1174](https://github.com/firefly-iii/firefly-iii/issues/1174)\n- Fixed spelling error that lead to 404's [issue 1175](https://github.com/firefly-iii/firefly-iii/issues/1175) [issue 1190](https://github.com/firefly-iii/firefly-iii/issues/1190)\n- Fixed tag autocomplete [issue 1178](https://github.com/firefly-iii/firefly-iii/issues/1178)\n- Better links for \"new transaction\" buttons [issue 1185](https://github.com/firefly-iii/firefly-iii/issues/1185)\n- Cache errors in budget charts [issue 1192](https://github.com/firefly-iii/firefly-iii/issues/1192)\n- Deleting transactions that are linked to other other transactions would lead to errors [issue 1209](https://github.com/firefly-iii/firefly-iii/issues/1209)\n\n\n## 4.7.0 - 2018-01-31 {#470-2018-01-31}\n\n### Added {#added_63}\n- Support for Russian and Portuguese (Brazil)\n- Support for the Spectre API (Salt Edge)\n- Many strings now translatable thanks to [Nik-vr](https://github.com/Nik-vr) ([issue 1118](https://github.com/firefly-iii/firefly-iii/issues/1118), [issue 1116](https://github.com/firefly-iii/firefly-iii/issues/1116), [issue 1109](https://github.com/firefly-iii/firefly-iii/issues/1109), )\n- Many buttons to quickly create stuff\n- Sum of tables in reports, requested by [MacPaille](https://github.com/MacPaille) ([issue 1106](https://github.com/firefly-iii/firefly-iii/issues/1106))\n- Future versions of Firefly III will notify you there is a new version, as suggested by [8bitgentleman](https://github.com/8bitgentleman) in [issue 1050](https://github.com/firefly-iii/firefly-iii/issues/1050)\n- Improved net worth box [issue 1101](https://github.com/firefly-iii/firefly-iii/issues/1101) ([Nik-vr](https://github.com/Nik-vr))\n- Nice dropdown in transaction list [issue 1082](https://github.com/firefly-iii/firefly-iii/issues/1082)\n- Better support for local fonts thanks to [devlearner](https://github.com/devlearner) ([issue 1145](https://github.com/firefly-iii/firefly-iii/issues/1145))\n- Improve attachment support and view capabilities (suggested by [trinhit](https://github.com/trinhit) in [issue 1146](https://github.com/firefly-iii/firefly-iii/issues/1146))\n\n\n### Changed {#changed_66}\n- Whole new [read me file](https://github.com/firefly-iii/firefly-iii/blob/main/readme.md), [new end user documentation](https://firefly-iii.readthedocs.io/en/latest/) and an [updated website](https://www.firefly-iii.org/)!\n- Many charts and info-blocks now scale property ([issue 989](https://github.com/firefly-iii/firefly-iii/issues/989) and [issue 1040](https://github.com/firefly-iii/firefly-iii/issues/1040))\n\n\n### Fixed {#fixed_145}\n- Charts work in IE thanks to [devlearner](https://github.com/devlearner) ([issue 1107](https://github.com/firefly-iii/firefly-iii/issues/1107))\n- Various fixes in import routine\n- Bug that left charts empty ([issue 1088](https://github.com/firefly-iii/firefly-iii/issues/1088)), reported by various users amongst which [jinformatique](https://github.com/jinformatique)\n- [Issue 1124](https://github.com/firefly-iii/firefly-iii/issues/1124), as reported by [gavu](https://github.com/gavu)\n- [Issue 1125](https://github.com/firefly-iii/firefly-iii/issues/1125), as reported by [gavu](https://github.com/gavu)\n- [Issue 1126](https://github.com/firefly-iii/firefly-iii/issues/1126), as reported by [gavu](https://github.com/gavu)\n- [Issue 1131](https://github.com/firefly-iii/firefly-iii/issues/1131), as reported by [dp87](https://github.com/dp87)\n- [Issue 1129](https://github.com/firefly-iii/firefly-iii/issues/1129), as reported by [gavu](https://github.com/gavu)\n- [Issue 1132](https://github.com/firefly-iii/firefly-iii/issues/1132), as reported by [gavu](https://github.com/gavu)\n- Issue with cache in Sandstorm ([issue 1130](https://github.com/firefly-iii/firefly-iii/issues/1130))\n- [Issue 1134](https://github.com/firefly-iii/firefly-iii/issues/1134)\n- [Issue 1140](https://github.com/firefly-iii/firefly-iii/issues/1140)\n- [Issue 1141](https://github.com/firefly-iii/firefly-iii/issues/1141), reported by [ErikFontanel](https://github.com/ErikFontanel)\n- [Issue 1142](https://github.com/firefly-iii/firefly-iii/issues/1142)\n\n\n### Security {#security_29}\n- Removed many access rights from the demo user\n\n\n## 4.6.13 - 2018-01-06 {#4613-2018-01-06}\n\n### Added {#added_64}\n- [Issue 1074](https://github.com/firefly-iii/firefly-iii/issues/1074), suggested by [MacPaille](https://github.com/MacPaille)\n- [Issue 1077](https://github.com/firefly-iii/firefly-iii/issues/1077), suggested by [wtercato](https://github.com/wtercato)\n- Bulk edit of transactions thanks to [vicmosin](https://github.com/vicmosin) ([issue 1078](https://github.com/firefly-iii/firefly-iii/issues/1078))\n- Support for Turkish.\n- [Issue 1090](https://github.com/firefly-iii/firefly-iii/issues/1090), suggested by [Findus23](https://github.com/Findus23)\n- [Issue 1097](https://github.com/firefly-iii/firefly-iii/issues/1097), suggested by [kelvinhammond](https://github.com/kelvinhammond)\n- [Issue 1093](https://github.com/firefly-iii/firefly-iii/issues/1093), suggested by [jinformatique](https://github.com/jinformatique)\n- [Issue 1098](https://github.com/firefly-iii/firefly-iii/issues/1098), suggested by [Nik-vr](https://github.com/Nik-vr)\n\n\n### Fixed {#fixed_146}\n- [Issue 972](https://github.com/firefly-iii/firefly-iii/issues/972), reported by [pjotrvdh](https://github.com/pjotrvdh)\n- [Issue 1079](https://github.com/firefly-iii/firefly-iii/issues/1079), reported by [gavu](https://github.com/gavu)\n- [Issue 1080](https://github.com/firefly-iii/firefly-iii/issues/1080), reported by [zjean](https://github.com/zjean)\n- [Issue 1083](https://github.com/firefly-iii/firefly-iii/issues/1083), reported by [skuzzle](https://github.com/skuzzle)\n- [Issue 1085](https://github.com/firefly-iii/firefly-iii/issues/1085), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 1087](https://github.com/firefly-iii/firefly-iii/issues/1087), reported by [4oo4](https://github.com/4oo4)\n- [Issue 1089](https://github.com/firefly-iii/firefly-iii/issues/1089), reported by [robin5210](https://github.com/robin5210)\n- [Issue 1092](https://github.com/firefly-iii/firefly-iii/issues/1092), reported by [kelvinhammond](https://github.com/kelvinhammond)\n- [Issue 1096](https://github.com/firefly-iii/firefly-iii/issues/1096), reported by [wtercato](https://github.com/wtercato)\n\n\n## 4.6.12 - 2017-12-31 {#4612-2017-12-31}\n\n### Added {#added_65}\n- Support for Indonesian.\n- New report, see [issue 384](https://github.com/firefly-iii/firefly-iii/issues/384)\n- [Issue 964](https://github.com/firefly-iii/firefly-iii/issues/964) as suggested by [gavu](https://github.com/gavu)\n\n\n### Changed {#changed_67}\n- Greatly improved Docker support and documentation.\n\n\n### Fixed {#fixed_147}\n- [Issue 1046](https://github.com/firefly-iii/firefly-iii/issues/1046), as reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 1047](https://github.com/firefly-iii/firefly-iii/issues/1047), as reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 1048](https://github.com/firefly-iii/firefly-iii/issues/1048), as reported by [webence](https://github.com/webence)\n- [Issue 1049](https://github.com/firefly-iii/firefly-iii/issues/1049), as reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 1015](https://github.com/firefly-iii/firefly-iii/issues/1015), as reported by a user on Tweakers.net\n- [Issue 1056](https://github.com/firefly-iii/firefly-iii/issues/1056), as reported by [repercussion](https://github.com/repercussion)\n- [Issue 1061](https://github.com/firefly-iii/firefly-iii/issues/1061), as reported by [Meizikyn](https://github.com/Meizikyn)\n- [Issue 1045](https://github.com/firefly-iii/firefly-iii/issues/1045), as reported by [gavu](https://github.com/gavu)\n- First code for [issue 1040](https://github.com/firefly-iii/firefly-iii/issues/1040) ([simonsmiley](https://github.com/simonsmiley))\n- [Issue 1059](https://github.com/firefly-iii/firefly-iii/issues/1059), as reported by [4oo4](https://github.com/4oo4)\n- [Issue 1063](https://github.com/firefly-iii/firefly-iii/issues/1063), as reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 1064](https://github.com/firefly-iii/firefly-iii/issues/1064), as reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 1066](https://github.com/firefly-iii/firefly-iii/issues/1066), reported by [wtercato](https://github.com/wtercato)\n\n\n\n## 4.6.11.1 - 2017-12-08 {#46111-2017-12-08}\n\n### Added {#added_66}\n- Import routine can scan for matching bills, [issue 956](https://github.com/firefly-iii/firefly-iii/issues/956)\n\n\n### Changed {#changed_68}\n- Import will no longer scan for rules, this has become optional. Originally suggested in [issue 956](https://github.com/firefly-iii/firefly-iii/issues/956) by [gavu](https://github.com/gavu)\n- [Issue 1033](https://github.com/firefly-iii/firefly-iii/issues/1033), as reported by [Jumanjii](https://github.com/Jumanjii)\n- [Issue 1033](https://github.com/firefly-iii/firefly-iii/issues/1034), as reported by [Aquariu](https://github.com/Aquariu)\n- Extra admin check for [issue 1039](https://github.com/firefly-iii/firefly-iii/issues/1039), as reported by [ocdtrekkie](https://github.com/ocdtrekkie)\n\n\n### Fixed {#fixed_148}\n- Missing translations ([issue 1026](https://github.com/firefly-iii/firefly-iii/issues/1026)), as reported by [gavu](https://github.com/gavu) and [zjean](https://github.com/zjean)\n- [Issue 1028](https://github.com/firefly-iii/firefly-iii/issues/1028), reported by [zjean](https://github.com/zjean)\n- [Issue 1029](https://github.com/firefly-iii/firefly-iii/issues/1029), reported by [zjean](https://github.com/zjean)\n- [Issue 1030](https://github.com/firefly-iii/firefly-iii/issues/1030), as reported by [Traxxi](https://github.com/Traxxi)\n- [Issue 1036](https://github.com/firefly-iii/firefly-iii/issues/1036), as reported by [webence](https://github.com/webence)\n- [Issue 1038](https://github.com/firefly-iii/firefly-iii/issues/1038), as reported by [gavu](https://github.com/gavu)\n\n\n## 4.6.11 - 2017-11-30 {#4611-2017-11-30}\n\n### Added {#added_67}\n- A debug page at `/debug` for easier debug.\n- Strings translatable (see [issue 976](https://github.com/firefly-iii/firefly-iii/issues/976)), thanks to [Findus23](https://github.com/Findus23)\n- Even more strings are translatable (and translated), thanks to [pkoziol](https://github.com/pkoziol) (see [issue 979](https://github.com/firefly-iii/firefly-iii/issues/979))\n- Reconciliation of accounts ([issue 736](https://github.com/firefly-iii/firefly-iii/issues/736)), as requested by [kristophr](https://github.com/kristophr) and several others\n\n\n### Changed {#changed_69}\n- Extended currency list, as suggested by [emuhendis](https://github.com/emuhendis) in [issue 994](https://github.com/firefly-iii/firefly-iii/issues/994)\n- [Issue 996](https://github.com/firefly-iii/firefly-iii/issues/996) as suggested by [dp87](https://github.com/dp87)\n\n\n### Removed {#removed_20}\n- Disabled Heroku support until I get it working again.\n\n\n### Fixed {#fixed_149}\n- [Issue 980](https://github.com/firefly-iii/firefly-iii/issues/980), reported by [Tim-Frensch](https://github.com/Tim-Frensch)\n- [Issue 987](https://github.com/firefly-iii/firefly-iii/issues/987), reported by [gavu](https://github.com/gavu)\n- [Issue 988](https://github.com/firefly-iii/firefly-iii/issues/988), reported by [gavu](https://github.com/gavu)\n- [Issue 992](https://github.com/firefly-iii/firefly-iii/issues/992), reported by [ncicovic](https://github.com/ncicovic)\n- [Issue 993](https://github.com/firefly-iii/firefly-iii/issues/993), reported by [gavu](https://github.com/gavu)\n- [Issue 997](https://github.com/firefly-iii/firefly-iii/issues/997), reported by [gavu](https://github.com/gavu)\n- [Issue 1000](https://github.com/firefly-iii/firefly-iii/issues/1000), reported by [xpfgsyb](https://github.com/xpfgsyb)\n- [Issue 1001](https://github.com/firefly-iii/firefly-iii/issues/1001), reported by [gavu](https://github.com/gavu)\n- [Issue 1002](https://github.com/firefly-iii/firefly-iii/issues/1002), reported by [ursweiss](https://github.com/ursweiss)\n- [Issue 1003](https://github.com/firefly-iii/firefly-iii/issues/1003), reported by [ursweiss](https://github.com/ursweiss)\n- [Issue 1004](https://github.com/firefly-iii/firefly-iii/issues/1004), reported by [Aquariu](https://github.com/Aquariu)\n- [Issue 1010](https://github.com/firefly-iii/firefly-iii/issues/1010)\n- [Issue 1014](https://github.com/firefly-iii/firefly-iii/issues/1014), reported by [ursweiss](https://github.com/ursweiss)\n- [Issue 1016](https://github.com/firefly-iii/firefly-iii/issues/1016)\n- [Issue 1024](https://github.com/firefly-iii/firefly-iii/issues/1024), reported by [gavu](https://github.com/gavu)\n- [Issue 1025](https://github.com/firefly-iii/firefly-iii/issues/1025), reported by [gavu](https://github.com/gavu)\n\n\n\n## 4.6.10 - 2017-11-03 {#4610-2017-11-03}\n\n### Added {#added_68}\n- Greatly expanded Docker support thanks to [alazare619](https://github.com/alazare619)\n- [Issue 967](https://github.com/firefly-iii/firefly-iii/issues/967), thanks to [Aquariu](https://github.com/Aquariu)\n\n\n### Changed {#changed_70}\n- Improved Sandstorm support.\n\n\n### Fixed {#fixed_150}\n- [Issue 963](https://github.com/firefly-iii/firefly-iii/issues/963), as reported by [gavu](https://github.com/gavu)\n- [Issue 970](https://github.com/firefly-iii/firefly-iii/issues/970), as reported by [gavu](https://github.com/gavu)\n- [Issue 971](https://github.com/firefly-iii/firefly-iii/issues/971), as reported by [gavu](https://github.com/gavu)\n- Various Sandstorm.io related issues.\n\n\n## 4.6.9 - 2017-10-22 {#469-2017-10-22}\n\n### Added {#added_69}\n- Firefly III is now available on the [Sandstorm.io](https://apps.sandstorm.io/app/uws252ya9mep4t77tevn85333xzsgrpgth8q4y1rhknn1hammw70) market.\n- Issue template\n- Pull request template\n- Clean up routine to remove double budget limits (see [issue 932](https://github.com/firefly-iii/firefly-iii/issues/932))\n\n\n### Changed {#changed_71}\n- Changed license to GPLv3.\n\n\n### Fixed {#fixed_151}\n- [Issue 895](https://github.com/firefly-iii/firefly-iii/issues/895), as reported by [gavu](https://github.com/gavu)\n- [Issue 902](https://github.com/firefly-iii/firefly-iii/issues/902), as reported by [gavu](https://github.com/gavu)\n- [Issue 916](https://github.com/firefly-iii/firefly-iii/issues/916), as reported by [gavu](https://github.com/gavu)\n- [Issue 942](https://github.com/firefly-iii/firefly-iii/issues/942), as reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 943](https://github.com/firefly-iii/firefly-iii/issues/943), as reported by [aclex](https://github.com/aclex)\n- [Issue 944](https://github.com/firefly-iii/firefly-iii/issues/944), as reported by [gavu](https://github.com/gavu)\n- [Issue 932](https://github.com/firefly-iii/firefly-iii/issues/932), as reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 933](https://github.com/firefly-iii/firefly-iii/issues/933), as reported by [nicoschreiner](https://github.com/nicoschreiner)\n\n\n## 4.6.8 - 2017-10-15 {#468-2017-10-15}\n\n### Added {#added_70}\n- Verify routine will check if deposits have a budget (they shouldn't).\n- New translations!\n\n\n### Changed {#changed_72}\n- Changed docker files for [issue 919](https://github.com/firefly-iii/firefly-iii/issues/919) and [issue 915](https://github.com/firefly-iii/firefly-iii/issues/915)\n\n\n### Fixed {#fixed_152}\n- [Issue 917](https://github.com/firefly-iii/firefly-iii/issues/917), as reported by [Wr0ngName](https://github.com/Wr0ngName)\n- Rules can no longer set a budget for a transfer or a deposit ([issue 916](https://github.com/firefly-iii/firefly-iii/issues/916))\n- Fixed [issue 925](https://github.com/firefly-iii/firefly-iii/issues/925), [issue 928](https://github.com/firefly-iii/firefly-iii/issues/928) as reported by [dzaikos](https://github.com/dzaikos) and [DeltaKiloz](https://github.com/DeltaKiloz)\n- A fix for [issue 926](https://github.com/firefly-iii/firefly-iii/issues/926), as reported by [Aquariu](https://github.com/Aquariu)\n\n\n## 4.6.7 - 2017-10-09 {#467-2017-10-09}\n\n### Added {#added_71}\n- [Issue 872](https://github.com/firefly-iii/firefly-iii/issues/872), reported [gavu](https://github.com/gavu)\n\n\n### Fixed {#fixed_153}\n- [Issue 878](https://github.com/firefly-iii/firefly-iii/issues/878), fixed by [Findus23](https://github.com/Findus23)\n- [Issue 881](https://github.com/firefly-iii/firefly-iii/issues/881), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 884](https://github.com/firefly-iii/firefly-iii/issues/884), by [gavu](https://github.com/gavu)\n- [Issue 840](https://github.com/firefly-iii/firefly-iii/issues/840), reported by [MacPaille](https://github.com/MacPaille)\n- [Issue 882](https://github.com/firefly-iii/firefly-iii/issues/882), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 891](https://github.com/firefly-iii/firefly-iii/issues/891), [issue 892](https://github.com/firefly-iii/firefly-iii/issues/892), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 891](https://github.com/firefly-iii/firefly-iii/issues/891), reported by [gavu](https://github.com/gavu)\n- [Issue 827](https://github.com/firefly-iii/firefly-iii/issues/827), fixed by [pkoziol](https://github.com/pkoziol)\n- [Issue 903](https://github.com/firefly-iii/firefly-iii/issues/903), fixed by [hduijn](https://github.com/hduijn)\n- [Issue 904](https://github.com/firefly-iii/firefly-iii/issues/904), reported by [gavu](https://github.com/gavu)\n- [Issue 910](https://github.com/firefly-iii/firefly-iii/issues/910), reported by [gavu](https://github.com/gavu)\n- [Issue 911](https://github.com/firefly-iii/firefly-iii/issues/911), reported by [gavu](https://github.com/gavu)\n- [Issue 915](https://github.com/firefly-iii/firefly-iii/issues/915), reported by [TomWis97](https://github.com/TomWis97)\n- [Issue 917](https://github.com/firefly-iii/firefly-iii/issues/917), reported by [Wr0ngName](https://github.com/Wr0ngName)\n\n\n## 4.6.6 - 2017-09-30 {#466-2017-09-30}\n\n### Added {#added_72}\n- [Issue 826](https://github.com/firefly-iii/firefly-iii/issues/826), reported by [pkoziol](https://github.com/pkoziol).\n- [Issue 855](https://github.com/firefly-iii/firefly-iii/issues/855), by [ms32035](https://github.com/ms32035)\n- [Issue 786](https://github.com/firefly-iii/firefly-iii/issues/786), by [SmilingWorlock](https://github.com/SmilingWorlock)\n- [Issue 875](https://github.com/firefly-iii/firefly-iii/issues/875), by [gavu](https://github.com/gavu)\n- [Issue 834](https://github.com/firefly-iii/firefly-iii/issues/834), by [gavu](https://github.com/gavu) (and others)\n\n\n\n### Changed {#changed_73}\n- Upgraded to Laravel 5.5\n- Add version parameter to CSS and JS files\n- [Issue 823](https://github.com/firefly-iii/firefly-iii/issues/823), [issue 824](https://github.com/firefly-iii/firefly-iii/issues/824) fixed Docker config by [DieBauer](https://github.com/DieBauer)\n\n\n### Fixed {#fixed_154}\n- [Issue 830](https://github.com/firefly-iii/firefly-iii/issues/830)\n- [Issue 822](https://github.com/firefly-iii/firefly-iii/issues/822), reported by [gazben](https://github.com/gazben)\n- [Issue 827](https://github.com/firefly-iii/firefly-iii/issues/827), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 835](https://github.com/firefly-iii/firefly-iii/issues/835), reported by [gavu](https://github.com/gavu)\n- [Issue 836](https://github.com/firefly-iii/firefly-iii/issues/836), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 838](https://github.com/firefly-iii/firefly-iii/issues/838), reported by [gavu](https://github.com/gavu)\n- [Issue 839](https://github.com/firefly-iii/firefly-iii/issues/839), reported by [gavu](https://github.com/gavu)\n- [Issue 843](https://github.com/firefly-iii/firefly-iii/issues/843), reported by [gavu](https://github.com/gavu)\n- [Issue 837](https://github.com/firefly-iii/firefly-iii/issues/837), reported by [gavu](https://github.com/gavu)\n- [Issue 845](https://github.com/firefly-iii/firefly-iii/issues/845), reported by [gavu](https://github.com/gavu)\n- [Issue 846](https://github.com/firefly-iii/firefly-iii/issues/846), reported by [gavu](https://github.com/gavu)\n- [Issue 848](https://github.com/firefly-iii/firefly-iii/issues/848), reported by [gavu](https://github.com/gavu)\n- [Issue 854](https://github.com/firefly-iii/firefly-iii/issues/854), reported by [gavu](https://github.com/gavu)\n- [Issue 866](https://github.com/firefly-iii/firefly-iii/issues/866), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 847](https://github.com/firefly-iii/firefly-iii/issues/847), reported by [gavu](https://github.com/gavu)\n- [Issue 853](https://github.com/firefly-iii/firefly-iii/issues/853), reported by [gavu](https://github.com/gavu)\n- [Issue 857](https://github.com/firefly-iii/firefly-iii/issues/857), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 865](https://github.com/firefly-iii/firefly-iii/issues/865), reported by [simonsmiley](https://github.com/simonsmiley)\n- [Issue 826](https://github.com/firefly-iii/firefly-iii/issues/826), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 856](https://github.com/firefly-iii/firefly-iii/issues/856), reported by [ms32035](https://github.com/ms32035)\n- [Issue 860](https://github.com/firefly-iii/firefly-iii/issues/860), reported by [gavu](https://github.com/gavu)\n- [Issue 861](https://github.com/firefly-iii/firefly-iii/issues/861), reported by [gavu](https://github.com/gavu)\n- [Issue 870](https://github.com/firefly-iii/firefly-iii/issues/870), reported by [gavu](https://github.com/gavu)\n\n\n## 4.6.5 - 2017-09-09 {#465-2017-09-09}\n\n\n\n### Added {#added_73}\n- [Issue 616](https://github.com/firefly-iii/firefly-iii/issues/616), The ability to link transactions\n- [Issue 763](https://github.com/firefly-iii/firefly-iii/issues/763), as suggested by [tannie](https://github.com/tannie)\n- [Issue 770](https://github.com/firefly-iii/firefly-iii/issues/770), as suggested by [skibbipl](https://github.com/skibbipl)\n- [Issue 780](https://github.com/firefly-iii/firefly-iii/issues/780), as suggested by [skibbipl](https://github.com/skibbipl)\n- [Issue 784](https://github.com/firefly-iii/firefly-iii/issues/784), as suggested by [SmilingWorlock](https://github.com/SmilingWorlock)\n- Lots of code for future support of automated Bunq imports\n\n\n### Changed {#changed_74}\n- Rewrote the export routine\n- [Issue 782](https://github.com/firefly-iii/firefly-iii/issues/782), as suggested by [NiceGuyIT](https://github.com/NiceGuyIT)\n- [Issue 800](https://github.com/firefly-iii/firefly-iii/issues/800), as suggested by [jleeong](https://github.com/jleeong)\n\n\n### Fixed {#fixed_155}\n- [Issue 724](https://github.com/firefly-iii/firefly-iii/issues/724), reported by [skibbipl](https://github.com/skibbipl)\n- [Issue 738](https://github.com/firefly-iii/firefly-iii/issues/738), reported by [skibbipl](https://github.com/skibbipl)\n- [Issue 760](https://github.com/firefly-iii/firefly-iii/issues/760), reported by [leander091](https://github.com/leander091)\n- [Issue 764](https://github.com/firefly-iii/firefly-iii/issues/764), reported by [tannie](https://github.com/tannie)\n- [Issue 792](https://github.com/firefly-iii/firefly-iii/issues/792), reported by [jleeong](https://github.com/jleeong)\n- [Issue 793](https://github.com/firefly-iii/firefly-iii/issues/793), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 797](https://github.com/firefly-iii/firefly-iii/issues/797), reported by [leander091](https://github.com/leander091)\n- [Issue 801](https://github.com/firefly-iii/firefly-iii/issues/801), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 803](https://github.com/firefly-iii/firefly-iii/issues/803), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 805](https://github.com/firefly-iii/firefly-iii/issues/805), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 806](https://github.com/firefly-iii/firefly-iii/issues/806), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 807](https://github.com/firefly-iii/firefly-iii/issues/807), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 808](https://github.com/firefly-iii/firefly-iii/issues/808), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 809](https://github.com/firefly-iii/firefly-iii/issues/809), reported by [pkoziol](https://github.com/pkoziol)\n- [Issue 814](https://github.com/firefly-iii/firefly-iii/issues/814), reported by [nicoschreiner](https://github.com/nicoschreiner)\n- [Issue 818](https://github.com/firefly-iii/firefly-iii/issues/818), reported by [gavu](https://github.com/gavu)\n- [Issue 819](https://github.com/firefly-iii/firefly-iii/issues/819), reported by [DieBauer](https://github.com/DieBauer)\n- [Issue 820](https://github.com/firefly-iii/firefly-iii/issues/820), reported by [simonsmiley](https://github.com/simonsmiley)\n- Various other fixes\n\n\n\n## 4.6.4 - 2017-08-13 {#464-2017-08-13}\n\n### Added {#added_74}\n- PHP7.1 support\n- Routine to decrypt attachments from the command line, for [issue 671](https://github.com/firefly-iii/firefly-iii/issues/671)\n- A routine that can check if your password has been stolen in the past.\n- Split transaction shows amount left to be split\n\n\n\n### Changed {#changed_75}\n- Importer can (potentially) handle new import routines such as banks.\n- Importer can fall back from JSON errors\n\n\n### Removed {#removed_21}\n- PHP7.0 support\n- Support for extended tag modes\n- Remove \"time jumps\" to non-empty periods\n\n\n\n### Fixed {#fixed_156}\n- [Issue 717](https://github.com/firefly-iii/firefly-iii/issues/717), reported by [NiceGuyIT](https://github.com/NiceGuyIT)\n- [Issue 718](https://github.com/firefly-iii/firefly-iii/issues/718), reported by [wtercato](https://github.com/wtercato)\n- [Issue 722](https://github.com/firefly-iii/firefly-iii/issues/722), reported by [simonsmiley](https://github.com/simonsmiley)\n- [Issue 648](https://github.com/firefly-iii/firefly-iii/issues/648), reported by [skibbipl](https://github.com/skibbipl)\n- [Issue 730](https://github.com/firefly-iii/firefly-iii/issues/730), reported by [ragnarkarlsson](https://github.com/ragnarkarlsson)\n- [Issue 733](https://github.com/firefly-iii/firefly-iii/issues/733), reported by [xpfgsyb](https://github.com/xpfgsyb)\n- [Issue 735](https://github.com/firefly-iii/firefly-iii/issues/735), reported by [kristophr](https://github.com/kristophr)\n- [Issue 739](https://github.com/firefly-iii/firefly-iii/issues/739), reported by [skibbipl](https://github.com/skibbipl)\n- [Issue 515](https://github.com/firefly-iii/firefly-iii/issues/515), reported by [schwalberich](https://github.com/schwalberich)\n- [Issue 743](https://github.com/firefly-iii/firefly-iii/issues/743), reported by [simonsmiley](https://github.com/simonsmiley)\n- [Issue 746](https://github.com/firefly-iii/firefly-iii/issues/746), reported by [tannie](https://github.com/tannie)\n- [Issue 747](https://github.com/firefly-iii/firefly-iii/issues/747), reported by [tannie](https://github.com/tannie)\n\n\n\n## 4.6.3.1 - 2017-07-23 {#4631-2017-07-23}\n\n### Fixed {#fixed_157}\n- Hotfix to close [issue 715](https://github.com/firefly-iii/firefly-iii/issues/715)\n\n\n## 4.6.3 - 2017-07-23 {#463-2017-07-23}\n\n\nThis will be the last release to support PHP 7.0.\n\n\n### Added {#added_75}\n- New guidelines and new introduction tour to aid new users.\n- Rules can now be applied at will to transactions, not just rule groups.\n\n\n### Changed {#changed_76}\n- Improved category overview.\n- Improved budget overview.\n- Improved budget report.\n- Improved command line import responsiveness and speed.\n- All code comparisons are now strict.\n- Improve search page.\n- Charts are easier to read thanks to [simonsmiley](https://github.com/simonsmiley)\n- Fixed [issue 708](https://github.com/firefly-iii/firefly-iii/issues/708).\n\n\n### Fixed {#fixed_158}\n- Fixed bug where import would not respect default account. [issue 694](https://github.com/firefly-iii/firefly-iii/issues/694)\n- Fixed various broken paths\n- Fixed several import inconsistencies.\n- Various bug fixes.\n\n\n## 4.6.2 - 2017-07-08 {#462-2017-07-08}\n\n### Added {#added_76}\n- Links added to boxes, idea by [simonsmiley](https://github.com/simonsmiley)\n\n\n### Fixed {#fixed_159}\n- Various bugs in import routine\n\n\n## 4.6.1 - 2017-07-02 {#461-2017-07-02}\n\n### Fixed {#fixed_160}\n- Fixed several small issues all around.\n\n\n## 4.6.0 - 2017-06-28 {#460-2017-06-28}\n\n\n\n### Changed {#changed_77}\n- Revamped import routine. Will be buggy.\n\n\n### Fixed {#fixed_161}\n- [Issue 667](https://github.com/firefly-iii/firefly-iii/issues/667), postgresql reported by [skibbipl](https://github.com/skibbipl).\n- [Issue 680](https://github.com/firefly-iii/firefly-iii/issues/680), fixed by [Xeli](https://github.com/Xeli)\n- Fixed [issue 660](https://github.com/firefly-iii/firefly-iii/issues/660)\n- Fixes [issue 672](https://github.com/firefly-iii/firefly-iii/issues/672), reported by [dzaikos](https://github.com/dzaikos)\n- Fix a bug where the balance routine forgot to account for accounts without a currency preference.\n- Various other bugfixes.\n\n\n## 4.5.0 - 2017-06-07 {#450-2017-06-07}\n\n\n\n### Added {#added_77}\n- Better support for multi-currency transactions and display of transactions, accounts and everything. This requires a database overhaul (moving the currency information to specific transactions) so be careful when upgrading.\n- Translations for Spanish and Slovenian.\n- New interface for budget page, ~~stolen from~~ inspired by YNAB.\n- Expanded Docker to work with postgresql as well, thanks to [kressh](https://github.com/kressh)\n\n\n### Fixed {#fixed_162}\n- PostgreSQL support in database upgrade routine ([issue 644](https://github.com/firefly-iii/firefly-iii/issues/644), reported by [skibbipl](https://github.com/skibbipl))\n- Frontpage budget chart was off, fix by [nhaarman](https://github.com/nhaarman)\n- Was not possible to remove opening balance.\n\n\n## 4.4.3 - 2017-05-03 {#443-2017-05-03}\n\n### Added {#added_78}\n- Added support for Slovenian\n- Removed support for Spanish. No translations whatsoever by the guy who requested it.\n- Removed support for Russian. Same thing.\n- Removed support for Croatian. Same thing.\n- Removed support for Chinese Traditional, Hong Kong. Same thing.\n\n\n### Changed {#changed_78}\n- The journal collector, an internal piece of code to collect transactions, now uses a slightly different method of collecting journals. This may cause problems.\n\n\n### Fixed {#fixed_163}\n- [Issue 638](https://github.com/firefly-iii/firefly-iii/issues/638) as reported by [worldworm](https://github.com/worldworm).\n- Possible fix for [issue 624](https://github.com/firefly-iii/firefly-iii/issues/624)\n\n\n## 4.4.2 - 2017-04-27 {#442-2017-04-27}\n\n### Fixed {#fixed_164}\n- Fixed a bug where the opening balance could not be stored.\n\n\n## 4.4.1 - 2017-04-27 {#441-2017-04-27}\n\n\n\n### Added {#added_79}\n- Support for deployment on Heroku\n\n\n### Fixed {#fixed_165}\n- Bug in new-user routine.\n\n\n## 4.4.0 - 2017-04-23 {#440-2017-04-23}\n\n### Added {#added_80}\n- Firefly III can now handle foreign currencies better, including some code to get the exchange rate live from the web.\n- Can now make rules for attachments, see [issue 608](https://github.com/firefly-iii/firefly-iii/issues/608), as suggested by [dzaikos](https://github.com/dzaikos).\n\n\n### Fixed {#fixed_166}\n- Fixed [issue 629](https://github.com/firefly-iii/firefly-iii/issues/629), reported by [forcaeluz](https://github.com/forcaeluz)\n- Fixed [issue 630](https://github.com/firefly-iii/firefly-iii/issues/630), reported by [welbert](https://github.com/welbert)\n- And more various bug fixes.\n\n\n## 4.3.8 - 2017-04-08 {#438-2017-04-08}\n\n\n\n### Added {#added_81}\n- Better overview / show pages.\n- [Issue 628](https://github.com/firefly-iii/firefly-iii/issues/628), as reported by [xzaz](https://github.com/xzaz).\n- Greatly expanded test coverage\n\n\n### Fixed {#fixed_167}\n- [Issue 619](https://github.com/firefly-iii/firefly-iii/issues/619), as reported by [dfiel](https://github.com/dfiel).\n- [Issue 620](https://github.com/firefly-iii/firefly-iii/issues/620), as reported by [forcaeluz](https://github.com/forcaeluz).\n- Attempt to fix [issue 624](https://github.com/firefly-iii/firefly-iii/issues/624), as reported by [TheSerenin](https://github.com/TheSerenin).\n- Favicon link is relative now, fixed by [welbert](https://github.com/welbert).\n- Some search bugs\n\n\n## 4.3.7 - 2017-03-06 {#437-2017-03-06}\n\n### Added {#added_82}\n- Nice user friendly views for empty lists.\n- Extended contribution guidelines.\n- First version of financial report filtered on tags.\n- Suggested monthly savings for piggy banks, by [Zsub](https://github.com/Zsub)\n- Better test coverage.\n\n\n### Changed {#changed_79}\n- Slightly changed tag overview.\n- Consistent icon for bill in list.\n- Slightly changed account overview.\n\n\n### Removed {#removed_22}\n- Removed IDE specific views from .gitignore, [issue 598](https://github.com/firefly-iii/firefly-iii/issues/598)\n\n\n### Fixed {#fixed_168}\n- Force key generation during installation.\n- The `date` function takes the fieldname where a date is stored, not the literal date by [Zsub](https://github.com/Zsub)\n- Improved budget frontpage chart, as suggested by [skibbipl](https://github.com/skibbipl)\n- [Issue 602](https://github.com/firefly-iii/firefly-iii/issues/602) and [issue 607](https://github.com/firefly-iii/firefly-iii/issues/607), as reported by [skibbipl](https://github.com/skibbipl) and [dzaikos](https://github.com/dzaikos).\n- [Issue 605](https://github.com/firefly-iii/firefly-iii/issues/605), as reported by [Zsub](https://github.com/Zsub).\n- [Issue 599](https://github.com/firefly-iii/firefly-iii/issues/599), as reported by [leander091](https://github.com/leander091).\n- [Issue 610](https://github.com/firefly-iii/firefly-iii/issues/610), as reported by [skibbipl](https://github.com/skibbipl).\n- [Issue 611](https://github.com/firefly-iii/firefly-iii/issues/611), as reported by [ragnarkarlsson](https://github.com/ragnarkarlsson).\n- [Issue 612](https://github.com/firefly-iii/firefly-iii/issues/612), as reported by [ragnarkarlsson](https://github.com/ragnarkarlsson).\n- [Issue 614](https://github.com/firefly-iii/firefly-iii/issues/614), as reported by [worldworm](https://github.com/worldworm).\n- Various other bug fixes.\n\n\n## 4.3.6 - 2017-02-20 {#436-2017-02-20}\n\n### Fixed {#fixed_169}\n- [Issue 578](https://github.com/firefly-iii/firefly-iii/issues/578), reported by [xpfgsyb](https://github.com/xpfgsyb).\n\n\n## 4.3.5 - 2017-02-19 {#435-2017-02-19}\n\n### Added {#added_83}\n- Beta support for Sandstorm.IO\n- Docker support by [schoentoon](https://github.com/schoentoon), [elohmeier](https://github.com/elohmeier), [patrickkostjens](https://github.com/patrickkostjens) and [crash7](https://github.com/crash7)!\n- Can now use special keywords in the search to search for specic dates, categories, etc.\n\n\n### Changed {#changed_80}\n- Updated to laravel 5.4!\n- User friendly error message\n- Updated locales to support more operating systems, first reported in [issue 536](https://github.com/firefly-iii/firefly-iii/issues/536) by [dabenzel](https://github.com/dabenzel)\n- Updated budget report\n- Improved 404 page\n- Smooth curves, improved by [elamperti](https://github.com/elamperti).\n\n\n### Fixed {#fixed_170}\n- [Issue 549](https://github.com/firefly-iii/firefly-iii/issues/549)\n- [Issue 553](https://github.com/firefly-iii/firefly-iii/issues/553)\n- Fixed [issue 559](https://github.com/firefly-iii/firefly-iii/issues/559) reported by [elamperti](https://github.com/elamperti).\n- [Issue 565](https://github.com/firefly-iii/firefly-iii/issues/565), as reported by a user over the mail\n- [Issue 566](https://github.com/firefly-iii/firefly-iii/issues/566), as reported by [dspeckmann](https://github.com/dspeckmann)\n- [Issue 567](https://github.com/firefly-iii/firefly-iii/issues/567), as reported by [winsomniak](https://github.com/winsomniak)\n- [Issue 569](https://github.com/firefly-iii/firefly-iii/issues/569), as reported by [winsomniak](https://github.com/winsomniak)\n- [Issue 572](https://github.com/firefly-iii/firefly-iii/issues/572), as reported by [zjean](https://github.com/zjean)\n- Many issues with the transaction filters which will fix reports (they tended to display the wrong amount).\n\n\n## 4.3.4 - 2017-02-02 {#434-2017-02-02}\n\n### Fixed {#fixed_171}\n- Fixed bug [issue 550](https://github.com/firefly-iii/firefly-iii/issues/550), reported by [worldworm](https://github.com/worldworm)!\n- Fixed bug [issue 551](https://github.com/firefly-iii/firefly-iii/issues/551), reported by [t-me](https://github.com/t-me)!\n\n\n## 4.3.3 - 2017-01-30 {#433-2017-01-30}\n\n\n_The 100th release of Firefly!_\n\n\n### Added {#added_84}\n- Add locales to Docker ([issue 534](https://github.com/firefly-iii/firefly-iii/issues/534)) by [elohmeier](https://github.com/elohmeier).\n- Optional database encryption. On by default.\n- Datepicker for Firefox and other browsers.\n- New instruction block for updating and installing.\n- Ability to clone transactions.\n- Use multi-select Bootstrap thing instead of massive lists of checkboxes.\n\n\n### Removed {#removed_23}\n- Lots of old Javascript\n\n\n### Fixed {#fixed_172}\n- Missing sort broke various charts\n- Bug in reports that made amounts behave weird\n- Various bug fixes\n\n\n### Security {#security_30}\n- Tested FF against the naughty string list.\n\n\n## 4.3.2 - 2017-01-09 {#432-2017-01-09}\n\n\nAn intermediate release because something in the Twig and Twigbridge libraries is broken and I have to make sure it doesn't affect you guys. But some cool features were on their way so there's that oo.\n\n\n### Added {#added_85}\n- Some code for [issue 475](https://github.com/firefly-iii/firefly-iii/issues/475), consistent overviews.\n- Better currency display. Make sure you have locale packages installed.\n\n\n### Changed {#changed_81}\n- Uses a new version of Laravel.\n\n\n### Fixed {#fixed_173}\n- The password reset routine was broken.\n- [Issue 522](https://github.com/firefly-iii/firefly-iii/issues/522), thanks to [xpfgsyb](https://github.com/xpfgsyb)\n- [Issue 524](https://github.com/firefly-iii/firefly-iii/issues/524), thanks to [worldworm](https://github.com/worldworm)\n- [Issue 526](https://github.com/firefly-iii/firefly-iii/issues/526), thanks to [worldworm](https://github.com/worldworm)\n- [Issue 528](https://github.com/firefly-iii/firefly-iii/issues/528), thanks to [skibbipl](https://github.com/skibbipl)\n- Various other fixes.\n\n\n## 4.3.1 - 2017-01-04 {#431-2017-01-04}\n\n### Added {#added_86}\n- Support for Russian and Polish.\n- Support for a proper demo website.\n- Support for custom decimal places in currencies ([issue 506](https://github.com/firefly-iii/firefly-iii/issues/506), suggested by [xpfgsyb](https://github.com/xpfgsyb)).\n- Most amounts are now right-aligned ([issue 511](https://github.com/firefly-iii/firefly-iii/issues/511), suggested by [xpfgsyb](https://github.com/xpfgsyb)).\n- German is now a \"complete\" language, more than 75% translated!\n\n\n### Changed {#changed_82}\n- **[New GitHub repository!](https://github.com/firefly-iii/firefly-iii)**\n- Better category overview.\n- [Issue 502](https://github.com/firefly-iii/firefly-iii/issues/502), thanks to [zjean](https://github.com/zjean)\n\n\n### Removed {#removed_24}\n- Removed a lot of administration functions.\n- Removed ability to activate users.\n\n\n### Fixed {#fixed_174}\n- [Issue 501](https://github.com/firefly-iii/firefly-iii/issues/501), thanks to [zjean](https://github.com/zjean)\n- [Issue 513](https://github.com/firefly-iii/firefly-iii/issues/513), thanks to [skibbipl](https://github.com/skibbipl)\n\n\n### Security {#security_31}\n- [Issue 519](https://github.com/firefly-iii/firefly-iii/issues/519), thanks to [xpfgsyb](https://github.com/xpfgsyb)\n\n\n## 4.3.0 - 2016-12-26 {#430-2016-12-26}\n\n### Added {#added_87}\n- New method of keeping track of available budget, see [issue 489](https://github.com/firefly-iii/firefly-iii/issues/489)\n- Support for Spanish\n- Firefly III now has an extended demo mode. Will expand further in the future.\n\n\n\n### Changed {#changed_83}\n- New favicon\n- Import routine no longer gives transactions a description [issue 483](https://github.com/firefly-iii/firefly-iii/issues/483)\n\n\n\n### Removed {#removed_25}\n- All test data generation code.\n\n\n### Fixed {#fixed_175}\n- Removed import accounts from search results [issue 478](https://github.com/firefly-iii/firefly-iii/issues/478)\n- Redirect after delete will no longer go back to deleted item [issue 477](https://github.com/firefly-iii/firefly-iii/issues/477)\n- Cannot math [issue 482](https://github.com/firefly-iii/firefly-iii/issues/482)\n- Fixed bug in virtual balance field [issue 479](https://github.com/firefly-iii/firefly-iii/issues/479)\n\n\n## 4.2.2 - 2016-12-18 {#422-2016-12-18}\n\n### Added {#added_88}\n- New budget report (still a bit of a beta)\n- Can now edit user\n\n\n### Changed {#changed_84}\n- New config for specific events. Still need to build Notifications.\n\n\n### Fixed {#fixed_176}\n- Various bugs\n- [Issue 472](https://github.com/firefly-iii/firefly-iii/issues/472) thanks to [zjean](https://github.com/zjean)\n\n\n## 4.2.1 - 2016-12-09 {#421-2016-12-09}\n\n### Added {#added_89}\n- BIC support (see [issue 430](https://github.com/firefly-iii/firefly-iii/issues/430))\n- New category report section and chart (see the general financial report)\n\n\n\n### Changed {#changed_85}\n- Date range picker now also available on mobile devices (see [issue 435](https://github.com/firefly-iii/firefly-iii/issues/435))\n- Extended range of amounts for [issue 439](https://github.com/firefly-iii/firefly-iii/issues/439)\n- Rewrote all routes. Old bookmarks may break.\n\n\n## 4.2.0 - 2016-11-27 {#420-2016-11-27}\n\n### Added {#added_90}\n- Lots of (empty) tests\n- Expanded transaction lists ([issue 377](https://github.com/firefly-iii/firefly-iii/issues/377))\n- New charts at account view\n- First code for [issue 305](https://github.com/firefly-iii/firefly-iii/issues/305)\n\n\n\n### Changed {#changed_86}\n- Updated all email messages.\n- Made some fonts local\n\n\n### Fixed {#fixed_177}\n- [Issue 408](https://github.com/firefly-iii/firefly-iii/issues/408)\n- Various issues with split journals\n- [Issue 414](https://github.com/firefly-iii/firefly-iii/issues/414), thx [zjean](https://github.com/zjean)\n- [Issue 419](https://github.com/firefly-iii/firefly-iii/issues/419), thx [schwalberich](https://github.com/schwalberich)\n- [Issue 422](https://github.com/firefly-iii/firefly-iii/issues/422), thx [xzaz](https://github.com/xzaz)\n- Various import bugs, such as [issue 416](https://github.com/firefly-iii/firefly-iii/issues/416) ([zjean](https://github.com/zjean))\n\n\n## 4.1.7 - 2016-11-19 {#417-2016-11-19}\n\n### Added {#added_91}\n- Check for database table presence in console commands.\n- Category report\n- Reinstated old test routines.\n\n\n\n### Changed {#changed_87}\n- Confirm account setting is no longer in `.env` file.\n- Titles are now in reverse (current page > parent > firefly iii)\n- Easier update of language files thanks to Github implementation.\n- Uniform colours for charts.\n\n\n### Fixed {#fixed_178}\n- Made all pages more mobile friendly.\n- Fixed [issue 395](https://github.com/firefly-iii/firefly-iii/issues/395) found by [marcoveeneman](https://github.com/marcoveeneman).\n- Fixed [issue 398](https://github.com/firefly-iii/firefly-iii/issues/398) found by [marcoveeneman](https://github.com/marcoveeneman).\n- Fixed [issue 401](https://github.com/firefly-iii/firefly-iii/issues/401) found by [marcoveeneman](https://github.com/marcoveeneman).\n- Many optimizations.\n- Updated many libraries.\n- Various bugs found by myself.\n\n\n\n## 4.1.6 - 2016-11-06 {#416-2016-11-06}\n\n### Added {#added_92}\n- New budget table for multi year report.\n\n\n### Changed {#changed_88}\n- Greatly expanded help pages and their function.\n- Built a new transaction collector, which I think was the idea of [roberthorlings](https://github.com/roberthorlings) originally.\n- Rebuilt seach engine.\n\n\n### Fixed {#fixed_179}\n- [Issue 375](https://github.com/firefly-iii/firefly-iii/issues/375), thanks to [schoentoon](https://github.com/schoentoon) which made it impossible to resurrect currencies.\n- [Issue 370](https://github.com/firefly-iii/firefly-iii/issues/370) thanks to [ksmolder](https://github.com/ksmolder)\n- [Issue 378](https://github.com/firefly-iii/firefly-iii/issues/378), thanks to [HomelessAvatar](https://github.com/HomelessAvatar)\n\n\n## 4.1.5 - 2016-11-01 {#415-2016-11-01}\n\n### Changed {#changed_89}\n- Report parts are loaded using AJAX, making a lot of code more simple.\n- Help content will fall back to English.\n- Help content is translated through Crowdin.\n\n\n### Fixed {#fixed_180}\n- [Issue 370](https://github.com/firefly-iii/firefly-iii/issues/370)\n\n\n## 4.1.4 - 2016-10-30 {#414-2016-10-30}\n\n### Added {#added_93}\n- New Dockerfile thanks to [schoentoon](https://github.com/schoentoon)\n- Added changing the destination account as rule action.\n- Added changing the source account as rule action.\n- Can convert transactions into different types.\n\n\n### Changed {#changed_90}\n- Changed the export routine to be more future-proof.\n- Improved help routine.\n- Integrated CrowdIn translations.\n- Simplified reports\n- Change error message to refer to solution.\n\n\n### Fixed {#fixed_181}\n- [Issue 367](https://github.com/firefly-iii/firefly-iii/issues/367) thanks to [HungryFeline](https://github.com/HungryFeline)\n- [Issue 366](https://github.com/firefly-iii/firefly-iii/issues/366) thanks to [3mz3t](https://github.com/3mz3t)\n- [Issue 362](https://github.com/firefly-iii/firefly-iii/issues/362) and [issue 341](https://github.com/firefly-iii/firefly-iii/issues/341) thanks to [bnw](https://github.com/bnw)\n- [Issue 355](https://github.com/firefly-iii/firefly-iii/issues/355) thanks to [roberthorlings](https://github.com/roberthorlings)\n\n\n## 4.1.3 - 2016-10-22 {#413-2016-10-22}\n\n### Fixed {#fixed_182}\n- Some event handlers called the wrong method.\n\n\n## 4.1.2 - 2016-10-22 {#412-2016-10-22}\n\n\n\n### Fixed {#fixed_183}\n- A bug is fixed in the journal event handler that prevented Firefly III from actually storing journals.\n\n\n## 4.1.1 - 2016-10-22 {#411-2016-10-22}\n\n\n\n### Added {#added_94}\n- Option to show deposit accounts on the front page.\n- Script to upgrade split transactions\n- Can now save notes on piggy banks.\n- Extend user admin options.\n- Run import jobs from the command line\n\n\n\n### Changed {#changed_91}\n- New preferences screen layout.\n\n\n### Deprecated {#deprecated_12}\n- ``firefly:import`` is now ``firefly:start-import``\n\n\n### Removed {#removed_26}\n- Lots of old code\n\n\n### Fixed {#fixed_184}\n- [Issue 357](https://github.com/firefly-iii/firefly-iii/issues/357), where non utf-8 files would break Firefly.\n- Tab delimiter is not properly loaded from import configuration ([roberthorlings](https://github.com/roberthorlings))\n- System response to yearly bills\n\n\n## 4.0.2 - 2016-10-14 {#402-2016-10-14}\n\n### Added {#added_95}\n- Added ``intl`` dependency to composer file to ease installation (thanks [telyn](https://github.com/telyn))\n- Added support for Croatian.\n\n\n### Changed {#changed_92}\n- Updated all copyright notices to refer to the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/)\n- Fixed [issue 344](https://github.com/firefly-iii/firefly-iii/issues/344)\n- Fixed [issue 346](https://github.com/firefly-iii/firefly-iii/issues/346), thanks to [SanderKleykens](https://github.com/SanderKleykens)\n- [Issue 351](https://github.com/firefly-iii/firefly-iii/issues/351)\n- Did some internal remodelling.\n\n\n### Fixed {#fixed_185}\n- PostgreSQL compatibility thanks to [SanderKleykens](https://github.com/SanderKleykens)\n- [roberthorlings](https://github.com/roberthorlings) fixed a bug in the ABN Amro import specific.\n\n\n\n## 4.0.1 - 2016-10-04 {#401-2016-10-04}\n\n### Added {#added_96}\n- New ING import specific by [tomwerf](https://github.com/tomwerf)\n- New Presidents Choice specific to fix [issue 307](https://github.com/firefly-iii/firefly-iii/issues/307)\n- Added some trimming ([issue 335](https://github.com/firefly-iii/firefly-iii/issues/335))\n\n\n### Fixed {#fixed_186}\n- Fixed a bug where incoming transactions would not be properly filtered in several reports.\n- [Issue 334](https://github.com/firefly-iii/firefly-iii/issues/334) by [cyberkov](https://github.com/cyberkov)\n- [Issue 337](https://github.com/firefly-iii/firefly-iii/issues/337)\n- [Issue 336](https://github.com/firefly-iii/firefly-iii/issues/336)\n- [Issue 338](https://github.com/firefly-iii/firefly-iii/issues/338) found by [roberthorlings](https://github.com/roberthorlings)\n\n\n## 4.0.0 - 2016-09-26 {#400-2016-09-26}\n\n### Added {#added_97}\n- Upgraded to Laravel 5.3, most other libraries upgraded as well.\n- Added GBP as currency, thanks to [Mortalife](https://github.com/Mortalife)\n\n\n### Changed {#changed_93}\n- Jump to version 4.0.0.\n- Firefly III is now subject to a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) license. Previous versions of this software are still MIT licensed.\n\n\n### Fixed {#fixed_187}\n- Support for specific decimal places, thanks to [Mortalife](https://github.com/Mortalife)\n- Various CSS fixes\n- Various bugs, thanks to [fuf](https://github.com/fuf), [sandermulders](https://github.com/sandermulders) and [vissert](https://github.com/vissert)\n- Various queries optimized for MySQL 5.7\n\n\n## 3.10.4 - 2016-09-14 {#3104-2016-09-14}\n\n### Fixed {#fixed_188}\n- Migration fix by [sandermulders](https://github.com/sandermulders)\n- Tricky import bug fix thanks to [vissert](https://github.com/vissert)\n- Currency preference will be correctly pulled from user settings, thanks to [fuf](https://github.com/fuf)\n- Simplified code for upgrade instructions.\n\n\n\n## 3.10.3 - 2016-08-29 {#3103-2016-08-29}\n\n### Added {#added_98}\n- More fields for mass-edit, thanks to [vissert](https://github.com/vissert) ([issue 282](https://github.com/firefly-iii/firefly-iii/issues/282))\n- First start of German translation\n\n\n### Changed {#changed_94}\n- More optional fields for transactions and the ability to filter them.\n\n\n### Removed {#removed_27}\n- Preference for budget maximum.\n\n\n### Fixed {#fixed_189}\n- A bug in the translation routine broke the import.\n- It was possible to destroy your Firefly installation by removing all currencies. Thanks [mondjef](https://github.com/mondjef)\n- Translation bugs.\n- Import bug.\n\n\n### Security {#security_32}\n- Firefly will not accept registrations beyond the first one, by default.\n\n\n\n## 3.10.2 - 2016-08-29 {#3102-2016-08-29}\n\n### Added {#added_99}\n- New Chinese translations. Set Firefly III to show incomplete translations to follow the progress. Want to translate Firefly III in Chinese, or in any other language? Then check out [the Crowdin project](https://crowdin.com/project/firefly-iii).\n- Added more admin pages. They do nothing yet.\n\n\n### Changed {#changed_95}\n- Import routine will now also apply user rules.\n- Various code cleanup.\n- Some small HTML changes.\n\n\n### Fixed {#fixed_190}\n- Bug in the mass edit routines.\n- Firefly III over a proxy will now work (see [issue 290](https://github.com/firefly-iii/firefly-iii/issues/290), thanks [dfiel](https://github.com/dfiel) for reporting.\n- Sneaky bug in the import routine, fixed by [Bonno](https://github.com/Bonno)\n\n\n## 3.10.1 - 2016-08-25 {#3101-2016-08-25}\n\n### Added {#added_100}\n- More feedback in the import procedure.\n- Extended model for import job.\n- Web bases import procedure.\n\n\n\n### Changed {#changed_96}\n- Scrutinizer configuration\n- Various code clean up.\n\n\n### Removed {#removed_28}\n- Code climate YAML file.\n\n\n### Fixed {#fixed_191}\n- Fixed a bug where a migration would check an empty table name.\n- Fixed various bugs in the import routine.\n- Fixed various bugs in the piggy banks pages.\n- Fixed a bug in the `firefly:verify` routine\n\n\n## 3.10 - 2016-08-12 {#310-2016-08-12}\n\n### Added {#added_101}\n- New charts in year report\n- Can add / remove money from piggy bank on mobile device.\n- Bill overview shows some useful things.\n- Firefly will track registration / activation IP addresses.\n\n\n\n### Changed {#changed_97}\n- Rewrote the import routine.\n- The date picker now supports more ranges and periods.\n- Rewrote all migrations. [issue 272](https://github.com/firefly-iii/firefly-iii/issues/272)\n\n\n### Fixed {#fixed_192}\n- [Issue 264](https://github.com/firefly-iii/firefly-iii/issues/264)\n- [Issue 265](https://github.com/firefly-iii/firefly-iii/issues/265)\n- Fixed amount calculation problems, [issue 266](https://github.com/firefly-iii/firefly-iii/issues/266), thanks [xzaz](https://github.com/xzaz)\n- [Issue 271](https://github.com/firefly-iii/firefly-iii/issues/271)\n- [Issue 278](https://github.com/firefly-iii/firefly-iii/issues/278), [issue 273](https://github.com/firefly-iii/firefly-iii/issues/273), thanks [StevenReitsma](https://github.com/StevenReitsma) and [rubella](https://github.com/rubella)\n- Bug in attachment download routine would report the wrong size to the user's browser.\n- Various NULL errors fixed.\n- Various strict typing errors fixed.\n- Fixed pagination problems, [issue 276](https://github.com/firefly-iii/firefly-iii/issues/276), thanks [xzaz](https://github.com/xzaz)\n- Fixed a bug where an expense would be assigned to a piggy bank if you created a transfer first.\n- Bulk update problems, [issue 280](https://github.com/firefly-iii/firefly-iii/issues/280), thanks [stickgrinder](https://github.com/stickgrinder)\n- Fixed various problems with amount reporting of split transactions.\n\n\n## 3.9.1 - 2016-06-06 {#391-2016-06-06}\n\n### Fixed {#fixed_193}\n- Fixed a bug where removing money from a piggy bank would not work. See [issue 265](https://github.com/firefly-iii/firefly-iii/issues/265) and [issue 269](https://github.com/firefly-iii/firefly-iii/issues/269)\n\n\n## 3.9.0 - 2016-05-22 {#390-2016-05-22}\n\n### Added {#added_102}\n- [zjean](https://github.com/zjean) has added code that allows you to force \"https://\"-URL's.\n- [tonicospinelli](https://github.com/tonicospinelli) has added Portuguese (Brazil) translations.\n- Firefly III supports the *splitting* of transactions:\n    - A withdrawal (expense) can be split into multiple sub-transactions (with multiple destinations)\n    - Likewise for deposits (incomes). You can set multiple sources.\n    - Likewise for transfers.\n\n\n### Changed {#changed_98}\n- Update a lot of libraries.\n- Big improvement to test data generation.\n- Cleaned up many repositories.\n\n\n### Removed {#removed_29}\n- Front page boxes will no longer respond to credit card bills.\n\n\n### Fixed {#fixed_194}\n- Many bugs\n\n\n## 3.8.4 - 2016-04-24 {#384-2016-04-24}\n\n### Added {#added_103}\n- Lots of new translations.\n- Can now set page size.\n- Can now mass edit transactions.\n- Can now mass delete transactions.\n- Firefly will now attempt to verify the integrity of your database when updating.\n\n\n### Changed {#changed_99}\n- New version of Charts library.\n\n\n### Fixed {#fixed_195}\n- Several CSV related bugs.\n- Several other bugs.\n- Bugs fixed by [Bonno](https://github.com/Bonno).\n\n\n## 3.8.3 - 2016-04-17 {#383-2016-04-17}\n\n### Added {#added_104}\n- New audit report to see what happened.\n\n\n### Changed {#changed_100}\n- New Chart JS release used.\n- Help function is more reliable.\n\n\n### Fixed {#fixed_196}\n- Expected bill amount is now correct.\n- Upgrade will now invalidate cache.\n- Search was broken.\n- Queries run better\n\n\n## 3.8.2 - 2016-04-03 {#382-2016-04-03}\n\n### Added {#added_105}\n- Small user administration at /admin.\n- Informational popups are working in reports.\n\n\n### Changed {#changed_101}\n- User activation emails are better\n\n\n### Fixed {#fixed_197}\n- Some bugs related to accounts and rules.\n\n\n\n## 3.8.1 - 2016-03-29 {#381-2016-03-29}\n\n### Added {#added_106}\n- More translations\n- Extended cookie control.\n- User accounts can now be activated (disabled by default).\n- Bills can now take the source and destination account name into account.\n\n\n### Changed {#changed_102}\n- The pages related to rules have new URL's.\n\n\n### Fixed {#fixed_198}\n- Spelling errors.\n- Problems related to the \"account repository\".\n- Some views showed empty (0.0) amounts.\n\n\n## 3.8.0 - 2016-03-20 {#380-2016-03-20}\n\n### Added {#added_107}\n- Two factor authentication, thanks to the excellent work of [zjean](https://github.com/zjean).\n- A new chart showing your net worth in year and multi-year reports.\n- You can now see if your current or future rules actually match any transactions, thanks to the excellent work of [roberthorlings](https://github.com/roberthorlings).\n- New date fields for transactions. They are not used yet in reports or anything, but they can be filled in.\n- New routine to export your data.\n- Firefly III will mail the site owner when blocked users try to login, or when blocked domains are used in registrations.\n\n\n\n### Changed {#changed_103}\n- Firefly III now requires PHP 7.0 minimum.\n\n\n\n### Fixed {#fixed_199}\n- HTML fixes, thanks to [roberthorlings](https://github.com/roberthorlings) and [zjean](https://github.com/zjean)..\n- A bug fix in the ABN Amro importer, thanks to [roberthorlings](https://github.com/roberthorlings)\n- It was not possible to change the opening balance, once it had been set. Thanks to [xnyhps](https://github.com/xnyhps) and [marcoveeneman](https://github.com/marcoveeneman) for spotting this.\n- Various other bug fixes.\n\n\n\n\n## 3.4.2 - 2015-05-25 {#342-2015-05-25}\n\n### Added {#added_108}\n- Initial release.\n\n\n### Changed {#changed_104}\n- Initial release.\n\n\n### Deprecated {#deprecated_13}\n- Initial release.\n\n\n### Removed {#removed_30}\n- Initial release.\n\n\n### Fixed {#fixed_200}\n- Initial release.\n\n\n### Security {#security_33}\n- Initial release.\n\n\n### API {#api_46}\n- Initial release\n",
      "documentId": "references/firefly-iii/changelog",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/firefly-iii/changelog/",
          "markdown": "https://sourcey-firefly.pages.dev/references/firefly-iii/changelog/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/json/index.md",
      "kind": "page",
      "title": "JSON configuration file",
      "description": "The data importer generates an import configuration file each time you import data. You can download the configuration file during or after the import.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/json/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/json/index.md",
      "file": "references/data-importer/json/index.md",
      "searchText": "\n# JSON configuration file {#json-configuration-file}\n\n\nThe data importer generates an import configuration file each time you import data. You can download the configuration file during or after the import.\n\nYou can use it to quickly configure your import the way you want to.\n\n\n## Example file {#example-file}\n\n\nThis is a typical configuration file with all options:\n\n```json\n{\n  \"date\": \"Ymd\",\n  \"default_account\": 49,\n  \"delimiter\": \"comma\",\n  \"headers\": true,\n  \"rules\": true,\n  \"skip_form\": false,\n  \"add_import_tag\": true,\n  \"specifics\": [\n    \"AppendHash\"\n  ],\n  \"roles\": [\n    \"date_transaction\",\n    \"description\",\n    \"amount\",\n    \"account-name\",\n    \"opposing-name\",\n    \"note\"\n  ],\n  \"do_mapping\": {\n    \"3\": true,\n    \"4\": true,\n    \"0\": false,\n    \"1\": false,\n    \"2\": false,\n    \"5\": false\n  },\n  \"mapping\": {\n    \"3\": {\n      \"Savings Account\": 3\n    },\n    \"4\": {\n      \"Savings Account\": 3\n    }\n  },\n  \"duplicate_detection_method\": \"classic\",\n  \"ignore_duplicate_lines\": false,\n  \"ignore_duplicate_transactions\": true,\n  \"unique_column_index\": 1,\n  \"unique_column_type\": \"external-id\",\n  \"version\": 3,\n  \"flow\": \"csv\",\n  \"identifier\": \"123456\",\n  \"connection\": \"789543\",\n  \"ignore_spectre_categories\": false,\n  \"map_all_data\": false,\n  \"accounts\": [\n    \n  ],\n  \"date_range\": \"all\",\n  \"date_range_number\": 30,\n  \"date_range_unit\": \"d\",\n  \"date_not_before\": \"2021-01-01\",\n  \"date_not_after\": \"2021-06-01\",\n  \"nordigen_country\": \"NL\",\n  \"nordigen_bank\": \"ABN_AMRO_XY\",\n  \"nordigen_requisitions\": [],\n  \"conversion\": true\n}\n```\n\n\n## Fields and values {#fields-and-values}\n\n\n\n\n> [!IMPORTANT]\n> Some options only apply to CSV files, others are exclusive to camt.053 files.\n\n\n\n\n### date {#date}\n\n\nSets the date format of the date entries in the file. If your file contains internationalized dates, you can prefix\nthe date format with your country code, like `it:` or `nl:`. Then, enter your date format.\n\nRead more about the format in the [PHP documentation](https://www.php.net/manual/en/datetime.format.php).\n\nHere are some examples:\n\n* `Ymd`. Will convert `20210318`\n* `F/j/Y`. Will convert `January/17/2021`\n* `nl:d F Y`. Will convert Dutch date `5 mei 2021`\n\n\n### default_account {#default_account}\n\n\nThe ID of the default asset accounts into which transactions will be imported if there's no source account. This is some\ntime useful when files just list the transactions and the destination, nothing more.\n\n\n### delimiter {#delimiter}\n\n\nThe delimiter of the entries in the CSV files. Most files use \"comma\", but you can also use \"semicolon\" or \"tab\".\n\n\n### headers {#headers}\n\n\nTrue or false if the CSV file has headers, a top row that explains what each column is for.\n\n\n### rules {#rules}\n\n\nWhether to apply your rules to the import. It is useful to run your rules after the import, although it will\nsignificantly slow down the import. The execution of rules can be slow when you have a lot of them.\n\n\n### skip_form {#skip_form}\n\n\nIf checked, next time you use the importer it will skip the configuration form. You can always go back to the form when\nusing the user interface.\n\n\n### roles {#roles}\n\n\nEach column in your CSV file gets a single role. This array in the JSON file indicates the role for each column. The\nuser interface shows you all the possible roles, but you can\nalso [read the code](https://github.com/firefly-iii/data-importer/blob/main/config/csv.php) to learn which\nroles are available.\n\nBelow is a list of possible roles:\n\n| role                  | description                              |\n|-----------------------|------------------------------------------|\n| _ignore               | (ignore this column)                     |\n| account-bic           | Asset account (BIC)                      |\n| account-iban          | Asset account (IBAN)                     |\n| account-id            | Asset account ID (matching FF3)          |\n| account-name          | Asset account (name)                     |\n| account-number        | Asset account (account number)           |\n| amount                | Amount                                   |\n| amount_credit         | Amount (credit column)                   |\n| amount_debit          | Amount (debit column)                    |\n| amount_foreign        | Amount (in foreign currency)             |\n| amount_negated        | Amount (negated column)                  |\n| subscription-id               | Subscription ID (matching FF3)                   |\n| bill-name             | Subscription name                                |\n| budget-id             | Budget ID (matching FF3)                 |\n| budget-name           | Budget name                              |\n| category-id           | Category ID (matching FF3)               |\n| category-name         | Category name                            |\n| currency-code         | Currency code (ISO 4217)                 |\n| currency-id           | Currency ID (matching FF3)               |\n| currency-name         | Currency name (matching FF3)             |\n| currency-symbol       | Currency symbol (matching FF3)           |\n| date_book             | Transaction booking date                 |\n| date_due              | Transaction due date                     |\n| date_interest         | Interest calculation date                |\n| date_invoice          | Transaction invoice date                 |\n| date_payment          | Transaction payment date                 |\n| date_process          | Transaction process date                 |\n| date_transaction      | Date                                     |\n| description           | Description                              |\n| external-id           | External ID                              |\n| external-url          | External URL                             |\n| foreign-currency-code | Foreign currency code (ISO 4217)         |\n| generic-debit-credit  | Generic bank debit/credit indicator      |\n| ing-debit-credit      | ING specific debit/credit indicator      |\n| internal_reference    | Internal reference                       |\n| note                  | Note(s)                                  |\n| opposing-bic          | Opposing account (BIC)                   |\n| opposing-iban         | Opposing account (IBAN)                  |\n| opposing-id           | Opposing account ID (matching FF3)       |\n| opposing-name         | Opposing account (name)                  |\n| opposing-number       | Opposing account (account number)        |\n| rabo-debit-credit     | Rabobank specific debit/credit indicator |\n| sepa_batch_id         | SEPA Batch ID                            |\n| sepa_cc               | SEPA Clearing Code                       |\n| sepa_ci               | SEPA Creditor Identifier                 |\n| sepa_country          | SEPA Country Code                        |\n| sepa_ct_id            | SEPA end-to-end Identifier               |\n| sepa_ct_op            | SEPA Opposing Account Identifier         |\n| sepa_db               | SEPA Mandate Identifier                  |\n| sepa_ep               | SEPA External Purpose                    |\n| tags-comma            | Tags (comma separated)                   |\n| tags-space            | Tags (space separated)                   |\n\n\n### do_mapping {#do_mapping}\n\n\nWhether these columns should be 'mapped' to data in your Firefly III installation. Mapping is a process where\nvalues in your CSV file will always point in a specific value in your Firefly III installation. For each column, it will\ntell the CSV importer if it should use the mapping in the next array. In the user interface, this is indicated by little\ncheck boxes after each column.\n\nHere are some examples:\n\n```json\n{\n  \"do_mapping\": [\n    true,\n    true,\n    false\n  ]\n}\n```\n\nColumn 0 and column 1 should be mapped, and column 2 should not. Keep in mind that the array counts from 0, so in your\nCSV file this would indicate: map the first two columns but don't map the third column.\n\nIn some JSON files, the order of `true` and `false` gets mixed up, which is why you'll see something like this:\n\n```json\n{\n  \"do_mapping\": {\n    \"0\": true,\n    \"2\": false,\n    \"1\": true\n  }\n}\n```\n\nWhat you see here is the same thing as the previous example. Map the first two columns, don't map the last one.\n\n\n### mapping {#mapping}\n\n\nThe mapping. The value in quotes is what's found in the CSV file. The numeric ID links to the object in your Firefly III\ninstallation. Here are some examples:\n\n```json\n{\n  \"0\": {\n    \"Groceries\": 3,\n    \"Grozeries\": 3,\n    \"Bills\": 2,\n    \"Going out\": 21\n  }\n}\n```\n\nThe 0 in this example refers to the first column, because we count from zero. In this example, if column `0` contains\neither `Groceries` or the misspelled variant the CSV importer should link to a category with ID #3. From the mapping\narray alone you can't tell that I'm talking about columns. This is something you can find or set in the `roles` array.\n\nAnother example:\n\n```json\n{\n  \"4\": {\n    \"NL21INGB9861487085\": 15,\n    \"NL35ABNA6289099205\": 23,\n    \"289099205\": 23\n  }\n}\n```\n\nThis example maps the account numbers in column #4 to account ID's in Firefly III.\n\nYou can configure a mapping for any column, but not all roles allow themselves to be mapped. For example, you can't map\nthe \"transaction amount\". If you try, it will be ignored.\n\n\n### duplicate_detection_method {#duplicate_detection_method}\n\n\nThe CSV importer has three methods to detect duplicate transactions. The [reference](/references/data-importer/duplicate-detection/)\npage has all the details. The JSON file reflects your choices.\n\n* `none`. Do no duplicate detection.\n* `classic`. Do content-based duplicate detection.\n* `cell`. Do identifier-based duplicate detection.\n\nAgain, to learn more about these options, read [the reference about duplicate detection](/references/data-importer/duplicate-detection/).\n\n\n### ignore_duplicate_lines {#ignore_duplicate_lines}\n\n\nRegardless of the choice of duplicate detection, you should leave this on `true`, so duplicated lines in your CSV files\nwill be removed.\n\n\n### ignore_duplicate_transactions {#ignore_duplicate_transactions}\n\n\nThis variable is not really used anymore, but it's an indicator of which `duplicate_detection_method` you're using.\nFor `classic`, it will always be `true`. Otherwise, it's `false`.\n\n\n### unique_column_index {#unique_column_index}\n\n\nThis contains the column number that contains the unique value for the duplicate detection. It's only ever used when you\nuse the `cell`-method, which stands for identifier-based duplicate detection. Read more\nabout [duplicate detection](/references/data-importer/duplicate-detection/).\n\n\n### unique_column_type {#unique_column_type}\n\n\nThis contains the field type of the unique identifier. It's only ever used when you use the `cell`-method, which stands\nfor identifier-based duplicate detection. Read more about [duplicate detection](/references/data-importer/duplicate-detection/).\n\n\n### version {#version}\n\n\nThe version should always be \"3\" so the importer knows how to parse your file.\n\n\n### add_import_tag {#add_import_tag}\n\n\nIf set to true, the import will the same tag to all transactions in the import.\n\n\n### flow {#flow}\n\n\nDetermines what is in your import. `csv`, `spectre` or `nordigen`. The `nordigen` variable refers to GoCardless.\n\n\n### identifier {#identifier}\n\n\nSpectre only, and contains the bank identifier.\n\n\n### connection {#connection}\n\n\nSpectre only, and contains the bank connection.\n\n\n### ignore_spectre_categories {#ignore_spectre_categories}\n\n\nSpectre only. Set to true, this will make the importer ignore Spectre's suggested categories.\n\n\n### map_all_data {#map_all_data}\n\n\nSpectre and GoCardless only. Is an indication if you wish to map data.\n\n\n### accounts {#accounts}\n\n\nSpectre and GoCardless only. A list of accounts from your provider that you wish to import, and into which Firefly III\naccount you want to import.\n\n\n### date_range {#date_range}\n\n\nSpectre and GoCardless only. What date range to import from your provider.\n\n- `all`: Import everything\n- `partial`: Go back `date_range_number` units of `date_range_unit` (see below)\n- `range`: Import a specific range\n\n\n### date_range_unit {#date_range_unit}\n\n\nSpectre and GoCardless only. `d` for days, `w` for weeks, `m` for months, `y` for years. Used only if date_range is partial.\n\n\n### date_range_number {#date_range_number}\n\n\nSpectre and GoCardless only. Number of days/weeks/months/years to go back. Used only if date_range is partial.\n\n\n### date_not_before {#date_not_before}\n\n\nSpectre and GoCardless only. Used only if date_range is `range`. Will not import from dates before the set date.\n\n\n### date_not_after {#date_not_after}\n\n\nSpectre and GoCardless only. Used only if date_range is `range`. Will not import from dates after the set date.\n\n\n### nordigen_country {#nordigen_country}\n\n\nGoCardless only. The country of the bank you selected to import from.\n\n\n### nordigen_bank {#nordigen_bank}\n\n\nGoCardless only. The bank you selected to import from.\n\n\n### nordigen_requisitions {#nordigen_requisitions}\n\n\nGoCardless only. A list of valid \"requisitions\" (permissions to import) from your bank.\n\n\n### conversion {#conversion}\n\n\nCSV only. If the importer should attempt to convert the file to UTF-8.\n",
      "documentId": "references/data-importer/json",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/json/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/json/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/roles/index.md",
      "kind": "page",
      "title": "Data field roles",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/roles/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/roles/index.md",
      "file": "references/data-importer/roles/index.md",
      "searchText": "\n# Data field roles {#data-field-roles}\n\n\nThe 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.\n\nThese options do not just apply to CSV files. Camt.053 files and Spectre and GoCardless imports also have roles assigned to their contents. For camt.053 there are less options for you to pick from per data field, since camt.053 standards are stricter. \n\nThe roles for data importer from Spectre and GoCardless cannot be configured. Those are pre-set by the developer. \n\n![Role selection in the data importer](/_media/039c22163f54b60b1c1c.png \"Role selection in the data importer\")\n\n\n## (ignore this column) {#ignore-this-column}\n\n\nSelect this role to ignore the content of the column.\n\n\n## Date {#date}\n\n\nThis sets the main date of the transaction. This date will be used for sorting transactions. If your CSV file also includes a timestamp *in the same column* you can include it in your date format, and it'll be parsed as well.\n\nIt's important to be consistent about the date you use. Especially when your CSV has several date fields. Choose the date closest to the actual transaction.\n\nExample data includes:\n\n```text\n2024-01-01\n03/31/2024\n2024-01-01 12:34:56\n```\n\nThe data importer needs your help to convert this date. The content is parsed using a special format. Read more about the format in the [PHP documentation](https://www.php.net/manual/en/datetime.format.php).\n\nHere are some examples:\n\n* `Ymd`. Will convert `20210318`\n* `F/j/Y`. Will convert `January/17/2021`\n* `nl:d F Y`. Will convert Dutch date `5 mei 2021`\n\n![Date configuration value \"Ymd\" is necessary to parse this file](/_media/356ec9e408befe7f7321.png \"Date configuration value 'Ymd' is necessary to parse this file\")\n\n\n## Description {#description}\n\n\nThe description of the transaction. If you select multiple columns to be the description of the transaction, the columns will be concatenated together.\n\nExample data includes:\n\n```text\nVB/000002628 INGDDEFFXXX DE94500105175185646536\nVishandel Hilvertshof HILVERSUM\tCard 1234\n```\n\n\n## Asset account (\\*) {#asset-account-}\n\n\nThese roles (\\*several variations) are used to indicate the asset account in the transaction, usually your own. Think of these columns as the \"payer\" column, the person or account paying the money.\n\nThe \"asset account\" role and the \"opposing account\" role (see ahead) will be automatically switched by the data importer when the transaction is the other way around.\n\nThe variations for this field are as follows:\n\n- IBAN: represents the IBAN of the asset account\n- Number: represents the account number, for when your bank does not use the IBAN system.\n- ID matching FF3: represents the ID of the asset account as it already exists in Firefly III. Banks don't generally know this ID, but you can map data to this value.\n- Name: represents the name of the asset account as it is saved in Firefly III. Banks don't use this name, but you can map data to this value.\n- BIC: represents the BIC value of this account\n\n\n## Opposing account (\\*) {#opposing-account-}\n\n\nThese roles (\\*in several variations) are used to indicate the opposing account. Usually these are stores or shops or opposing account details. Think of these columns as the \"payee\" column, the person or account receiving the money.\n\nThe \"asset account\" role and the \"opposing account\" role (see earlier) will be automatically switched by the data importer when the transaction is the other way around.\n\nThe variations for this field are as follows:\n\n- IBAN: represents the IBAN of the opposing account\n- Number: represents the account number, for when your bank does not use the IBAN system.\n- ID matching FF3: represents the ID (see the URL) of the opposing account as it already exists in Firefly III. Banks don't generally know this ID, but you can map data to this value.\n- Name: represents the name of the opposing account as it is saved in Firefly III. Banks don't use this name, but you can map data to this value.\n- BIC: represents the BIC value of this opposing account\n\n\n## Amount {#amount}\n\n\nIndicates the amount of the transaction. Most of the time, the amount is stored both positive and negative. The data importer can handle this automatically. Use \"Amount (negated column)\" if the transactions get imported the wrong way around.\n\nExample data includes:\n\n```csv\n12.34\n-56.78\n99.99\n```\n\n\n## Amount (in foreign currency) {#amount-in-foreign-currency}\n\n\nIndicates the foreign amount of the transaction. If you select a column that contains the foreign amount, you must also select the \"Foreign currency code (ISO 4217)\" role. Otherwise, it may not be possible to import a foreign amount.\n\n\n## Amount (credit / debit column) {#amount-credit--debit-column}\n\n\nSome banks split the amount in two columns. One for debits, one for credits. Use this column type for either field. This is relevant when you see TWO columns with amount data in your CSV file.\n\n```csv\ndescription,debit,credit\nYou buy groceries,12.34,\nYou get a refund,,12.34\n```\n\n\n## Bank specific credit/debit indicator {#bank-specific-creditdebit-indicator}\n\n\nSome banks use a column with a magic letter or word to indicate if the transaction is an expense or income. The data importer has a role for such columns, and [most letters are recognized](https://github.com/firefly-iii/data-importer/blob/main/app/Services/CSV/Converter/BankDebitCredit.php#L51).\n\nThis is useful when your data is something like this:\n\n```csv\n12.34;CR;\n56.78;DB;\n```\n\n\n## Subscription {#subscription}\n\n\nUse this field to link the transaction to the right subscription. You can use the subscription name or the subscription ID. Few banks deliver enough data to deduce the Firefly III subscription, so this field is not used often by users. However, if your bank happens to classify transactions for you, you may be able to use it.\n\n- Subscription name: expects the content of the field to be the literal subscription name in Firefly III\n- Subscription ID: expects the content of the field to be the literal subscription ID (see the URL) in Firefly III\n\nThe content of this field can be mapped, so \"SOMEVAL\" can be mapped to \"Some Value\" in Firefly III.\n\n\n## Budget {#budget}\n\n\nUse this field to link the transaction to the right budget. Few banks deliver enough data to deduce the Firefly III budget, so this field is not used often by users. However, if your bank happens to classify transactions for you, you may be able to use it.\n\n- Budget name: expects the content of the field to be the literal budget name in Firefly III\n- Budget ID: expects the content of the field to be the literal budget ID (see the URL) in Firefly III\n\n- The content of this field can be mapped, so \"SOMEVAL\" can be mapped to \"Some Value\" in Firefly III.\n\n\n## Category {#category}\n\n\nUse this field to link the transaction to the right category. Although few banks actually do this, some banks give your transactions categories, if only what type of expense (like wether it was by card, check or touchless payment). The content of this field can be mapped, so \"SOMEVAL\" can be mapped to \"Some Value\" in Firefly III.\n\n\n## Currency code / name / symbol {#currency-code--name--symbol}\n\n\nUse this field to set the currency of the transaction. The currency ID must match the Firefly III currency IDs. This is never the case of course.\n\nThe content of this field can be mapped, so \"E\" can be mapped to \"Euro\" in Firefly III.\n\n\n## Foreign currency code (ISO 4217) {#foreign-currency-code-iso-4217}\n\n\nUse this field to set the currency code of the foreign amount of the transaction. This works the same as the normal currency fields.\n\n\n## Meta date fields {#meta-date-fields}\n\n\nConsists of:\n\n- Interest calculation date\n- Transaction booking date\n- Transaction process date\n- Transaction due date\n- Transaction payment date\n- Transaction invoice date\n\nThese are meta-dates related to the transaction you can set. Import these dates so data isn't lost. Most people use the date that is closest to the actual transaction date as the main date (see earlier in the text about the \"date\" field). The other dates can be stored pretty much as you wish. When reconciling transactions it might be useful to select the processing date of the bank as the date.\n\nIf you are importing, always make sure you have at least one \"Transaction date\" field configured, or your transactions will not be imported with the correct date.\n\n\n## External ID / Internal reference {#external-id--internal-reference}\n\n\nSome banks give transactions their own ID's. Often, you can find these values in the first column of your CSV file. If you are reasonably sure this number is unique, store it in either the external ID or internal reference field (this is up to you). Firefly III can use these values to check for duplicates.\n\n\n## Tags {#tags}\n\n\nThe Firefly III can import space and comma separated tags. This can be useful when your bank submits automated tags with your transactions. The tags will be split and stored in Firefly III.\n\n\n## Note(s) {#notes}\n\n\nAny notes you wish to import. If you select multiple columns to be stored in the notes field, they will be concatenated together. It's not that column A will override column B, for example.\n\nMultilines notes spanning to more than one line can be imported, just remember to close quotes correctly and to use [Markdown format](https://www.markdownguide.org/basic-syntax/#line-breaks):\n\n> ```\n> \"this\",\"is my\",\"csv line\",\"with my notes: to add a newline, finish a sentence with two spaces  \n> and continue on the next line\n> \n> or give a double enter\"\n> ```\n\nIn Firefly III you'll see the notes this way:\n\n![How your notes will be presented in Firefly III](/_media/d1908bf0cc6d241f176b.png)\n\n\n## SEPA fields {#sepa-fields}\n\n\nThe Firefly III CSV importer can import several [SEPA](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) related fields. As a rule, these are read-only after importing.\n\n- SEPA end-to-end Identifier\n- SEPA Opposing Account Identifier\n- SEPA Mandate Identifier\n- SEPA Clearing Code\n- SEPA Creditor Identifier\n- SEPA External Purpose\n- SEPA Country Code\n- SEPA Batch ID\n\n\n## Other leftover fields {#other-leftover-fields}\n\n\nMany CSV files contain extra data. Things like zip codes, retention policies or other data that doesn't really fit in Firefly III can be stored in the \"notes\"-field. This doesn't make the data more easily accessible but at least it'll be saved.\n",
      "documentId": "references/data-importer/roles",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/roles/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/roles/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/third-party-tools/index.md",
      "kind": "page",
      "title": "Third-party tools",
      "description": "There are various scripts and tools you can use, if the Firefly III Data Importer does not fit your use case.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/third-party-tools/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/third-party-tools/index.md",
      "file": "references/data-importer/third-party-tools/index.md",
      "searchText": "\n# Third-party tools {#third-party-tools}\n\n\nThere are various scripts and tools you can use, if the Firefly III Data Importer does not fit your use case.\n\n\n\n> [!IMPORTANT]\n> These are all developed by other users, feel free to contact them if you have support questions.\n\n\n\n\n## Transaction classification {#transaction-classification}\n\n\n[TransCat](https://github.com/Hapyr/trans-cat) can pre-process your CSV file and automatically assign your transactions to a category based on previous assignments.\n\n\n## Import tools {#import-tools}\n\n\n\n## Firemerge {#firemerge}\n\n\n[A customizable tool](https://github.com/lvu/firemerge) for semi-automated (not automated!) transaction entry for Firefly III.\n\n\n## TrueLayer to Firefly III {#truelayer-to-firefly-iii}\n\n\n[truelayer2firefly](https://erwindouna.github.io/truelayer2firefly/) can import transactions from the TrueLayer-platform into Firefly III. TrueLayer is comparable to Salt Edge and GoCardless.\n\n\n### FF3-OFX {#ff3-ofx}\n\n\n[FF3-OFX](https://github.com/pelaxa/ff3-ofx) is a React application that can be used to import transactions using your financial institution's OFX (Money format) exports.\n\n\n### Splitwise {#splitwise}\n\n\n\"[Splitwise Firefly Sync](https://github.com/adyanth/splitwise-firefly-sync)\" syncs the expenses from Splitwise to Firefly III using their respective APIs.\n\n\n### FinTS {#fints}\n\n\n\"[Firefly III FinTS importer](https://github.com/bnw/firefly-iii-fints-importer)\" allows you to import using FinTS, a bank-independent protocol for online banking, developed and used by German banks.\n\n\n### FinTS console {#fints-console}\n\n\n\"[Firefly III FinTS console importer](https://github.com/Gared/firefly-iii-fints-console-importer)\" allows you to import using FinTS similar to the previous importer, but operates entirely via the command line and enables automated imports.\n\n\n### CAMT (ISO 20022) {#camt-iso-20022}\n\n\n[This script](https://github.com/plumped/camt_converter_ISO20022_for_camt) allows you to unzip zip files with camt.053 in them and convert them into CSV for easy processing.\n\n\n\n> [!IMPORTANT]\n> Since the data importer supports camt.053 files, this is no necessary.\n\n\n\n\n### GnuCash {#gnucash}\n\n\nThis experimental [Python script](https://gist.github.com/adyanth/20c004869baf33458e416d4396ca40a8) can convert GnuExports to Firefly III compatible JSON.\n\n\n### Plaid {#plaid}\n\n\n[Plaid](https://plaid.com/) is a data aggregation service just like Spectre's Salt Edge API mentioned earlier.\n\n- GitLab-user [@GeorgeHahn](https://gitlab.com/GeorgeHahn) built a tool to import from Plaid. [Website and documentation](https://gitlab.com/GeorgeHahn/firefly-plaid-connector)\n- GitHub-user [@dvankley](https://github.com/dvankley) built an alternative Plaid importer tool. [Website and documentation](https://github.com/dvankley/firefly-plaid-connector-2)\n\n\n\n> [!WARNING]\n> The free Plaid program is meant for testing and your milage may vary.\n\n\n\n\n## Bank-specific tools {#bank-specific-tools}\n\n\n\n### Up Bank Australia {#up-bank-australia}\n\n\nThese applications allow you to import data from Australian Bank \"Up\":\n\n- \"[UpBankFFImporter](https://github.com/MajorArkwolf/UpBankFFImporter)\" by [@MajorArkwolf](https://github.com/MajorArkwolf)\n- \"[UP_Firefly_API_Connector](https://blog.dupreez.id.au/2021/01/automatically-update-firefly-iii-with-up-banking-transactions/)\" by [@Mugl3](https://github.com/Mugl3)\n\n\n### Credit Agricole {#credit-agricole}\n\n\n[This Python app](https://github.com/Royalphax/credit-agricole-importer) allows you to import transactions from Crédit Agricole\n\n\n### Crypto exchanges {#crypto-exchanges}\n\n\n[This service](https://github.com/financelurker/crypto-trades-firefly-iii) by [@financelurker](https://github.com/financelurker) lets you import activities from your crypto exchange accounts (like \"Binance/binance.com\") to your FireFly III account.\n\n\n### PayPal {#paypal}\n\n\n\"[Firefly III PayPal importer](https://github.com/robvankeilegom/firefly-III-paypal-importer)\" by [@robvankeilegom](https://github.com/robvankeilegom) to pull data from the PayPal API and push it to your Firefly III instance.\n\n\n### Revolut {#revolut}\n\n\nIf you're banking with Revolut, you can use the [Revolut importer](https://gitlab.com/ludo444/fireflyrevoluttransactions), which is built by GitLab user [@ludo444](https://gitlab.com/ludo444).\n\n\n\n> [!IMPORTANT]\n> Want your app on this list? Open an [issue on GitHub](https://github.com/firefly-iii/firefly-iii/issues/)!\n\n\n\n",
      "documentId": "references/data-importer/third-party-tools",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/third-party-tools/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/third-party-tools/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/public/index.md",
      "kind": "page",
      "title": "Public installation",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/public/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/public/index.md",
      "file": "references/data-importer/public/index.md",
      "searchText": "\n# Public installation {#public-installation}\n\n\nThere is a public (cloud-based) instance of the Firefly III Data Importer running on [https://data-importer.firefly-iii.org](https://data-importer.firefly-iii.org) that anybody can use.\n\nYou can use this instance to import data into your own installation. Please keep in mind it comes with a \"price\".\n\n- Your own Firefly III installation must be reachable over the internet. This may be a security and privacy risk.\n- Create a public client (uncheck the \"confidential\"-flag) that uses the following callback URL: `https://data-importer.firefly-iii.org/callback`.\n- Any private data you upload may be stored for up to 24hrs.\n\nI appreciate the complexity of running the data importer for yourself so this cloud instance can help you import data into your own installation.\n\n\n\n> [!WARNING]\n> **Be careful**\n>\n> There **no guarantee** that the server won't be hacked. You also have **no guarantee** that I won't snoop through your files. A bug may make your files public to other users. I'm afraid I can give you zero guarantees and no warranty.\n\n\n",
      "documentId": "references/data-importer/public",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/public/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/public/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/duplicate-detection/index.md",
      "kind": "page",
      "title": "Duplicate detection",
      "description": "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 will not be imported again.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/duplicate-detection/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/duplicate-detection/index.md",
      "file": "references/data-importer/duplicate-detection/index.md",
      "searchText": "\n# Duplicate detection {#duplicate-detection}\n\n\nThe 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 will not be imported again.\n\nThe data importer has two ways of detecting duplicates. They are explained further ahead. Sometimes the first method is better, and sometimes the second one. This depends a little bit on your import. In most cases \"content-based\" (see ahead) duplicate detection works well enough.\n\nIf you run into problems when using duplicate detection, please read [how to manage (missed) duplicates](/how-to/data-importer/import/duplicates/).\n\n\n### Content-based {#content-based}\n\n\nTechnically speaking, Firefly III handles \"content-based\" duplicate detection, and it works as follows.\n\nFirst, the data importer prepares the transaction. This includes all the mappings and roles you've configured. This does NOT include rules or webhooks, since Firefly III itself is responsible for those. The data importer finalises the transaction and sends it to Firefly III. Here's an example from the data importer logs:\n\n```\nSubmitting to Firefly III: {\"group_title\":null,\"error_if_duplicate_hash\":false,\"transactions\":[ ... ]} \n```\n\nThe first thing Firefly III will do is generate a hash over this array. You can see this in the Firefly III logs. Remember, Firefly III is doing the duplicate checking:\n\n```\nNow in TransactionGroupFactory::create()\n...  \nNow creating journal 1/1  \nThe hash is: 616290b9c880d9b353e7a1b1c3d23d622a10abf6ec532cdebe966cc3e5151d2d { ... }\n```\n\nAfter this hash is created, Firefly III will search for other transactions with the same hash. If it finds them, it reports a duplicate back to the data importer.\n\nThis way of processing transactions means that:\n\n- Any (changed) rules in Firefly III do not influence the duplicate detection\n- If you edit the transaction after it's imported, the hash remains the same, it will not be updated\n- The original (\"as is\") transaction is checked for duplicates, not the end result after rules or webhooks\n\nConversely, it also means that:\n\n- If you change the mapping, or the roles of the data before it gets send to Firefly III, the hash changes\n- If your bank uses new transaction IDs or changes the CapItaliZAtiON, the hash changes\n\n\n### Identifier-based {#identifier-based}\n\n\nIdentifier-based duplicate detection is handled by the data importer. Each transaction you wish to import **must** have a unique identifier in a column.\n\nIf you select the column and the field it should be stored in, the data importer will search your Firefly III installation for this specific identifier. When Firefly III reports it's been found, the transaction will not be imported (again). \n\n\n#### CSV-based identifier-based duplicate detection {#csv-based-identifier-based-duplicate-detection}\n\n\nThe fields that are available are:\n\n* The notes: The column(s) in your CSV file that you map to the \"Notes\"-field are compared to spot duplicates.\n* External identifier: The column in your CSV file that you map to the \"External identifier\"-field is compared to spot duplicates.\n* Transaction description: The column(s) in your CSV file that you map to the \"Description\"-field are compared to spot duplicates.\n* Internal reference: The column in your CSV file that you map to the \"External identifier\"-field is compared to spot duplicates.\n\nIn all of these cases it's important that you always select the same roles for the same columns, or duplicate detection may not work as expected.\n\n\n\n#### Nordigen identifier-based duplicate detection {#nordigen-identifier-based-duplicate-detection}\n\n\nFor Nordigen only two fields are available to be used for identifier-based duplicate detection, because the API is pretty consistent in what it delivers:\n\n* External identifier: The entry in each downloaded transaction that uniquely defines each transaction. \n* Additional information: The free format text in each downloaded transaction that contains some extra information of each transaction. \n\nThe external identifier is a given field. If it does not exist, the data importer will add it for you. This is a very reliable way to detect duplicates.\n\nSome users prefer the \"additional information\"-field. What it contains is different per bank, but sometimes it contains some kind of ID, so it can be used as well.\n",
      "documentId": "references/data-importer/duplicate-detection",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/duplicate-detection/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/duplicate-detection/index.md"
        }
      ]
    },
    {
      "id": "references/data-importer/changelog/index.md",
      "kind": "page",
      "title": "Change Log",
      "description": "All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/data-importer/changelog/",
      "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/changelog/index.md",
      "file": "references/data-importer/changelog/index.md",
      "searchText": "\n# Change Log {#change-log}\nAll notable changes to this project will be documented in this file.\nThis project adheres to [Semantic Versioning](http://semver.org/).\n\n\n## 1.3.12 - 2023-11-23 {#1312-2023-11-23}\n\n\n\n### Added {#added}\n- Support for Mint imports. Use [this configuration file](https://github.com/firefly-iii/import-configurations/blob/main/other-software/mint.json).\n\n\n## 1.3.11 - 2023-11-23 {#1311-2023-11-23}\n\n\n\n### Changed {#changed}\n- Add some more explanation text to the date input\n\n\n### Fixed {#fixed}\n- [Issue 8184](https://github.com/firefly-iii/firefly-iii/issues/8184) I broke the importer\n\n\n## 1.3.10 - 2023-11-21 {#1310-2023-11-21}\n\n\n>  ⚠️ Some changes in this release may unexpectedly lead to duplicate transactions. This is caused by changes in the data handling routines. This is unfortunate, but a result of new insights, changed APIs and other minor fixes. My apologies for any inconvenience. I try to avoid these kinds of changes, but it can't always be helped.\n\n\n### Added {#added_1}\n- [Issue 7977](https://github.com/firefly-iii/firefly-iii/issues/7977) More details on accounts added\n\n\n### Changed {#changed_1}\n- Renamed Nordigen to GoCardless\n\n\n### Fixed {#fixed_1}\n- [Issue 8130](https://github.com/firefly-iii/firefly-iii/issues/8130) External ID with space breaks duplicate check\n- [Issue 8158](https://github.com/firefly-iii/firefly-iii/issues/8158) Several nullpointers\n\n\n\n## 1.3.9 - 2023-11-04 {#139-2023-11-04}\n\n\n>  ⚠️ Some changes in this release may unexpectedly lead to duplicate transactions. This is caused by changes in the data handling routines. This is unfortunate, but a result of new insights, changed APIs and other minor fixes. My apologies for any inconvenience. I try to avoid these kinds of changes, but it can't always be helped.\n\n\n### Added {#added_2}\n- Fancy new security.txt file.\n\n\n### Changed {#changed_2}\n- Better safety catches for Nordigen and Spectre, in case they accidentally try to create deposits or withdrawals that should be transfers.\n\n\n### Fixed {#fixed_2}\n- [Issue 7948](https://github.com/firefly-iii/firefly-iii/issues/7948) Null pointer exception in CAMT processing.\n- [Issue 8005](https://github.com/firefly-iii/firefly-iii/issues/8005) Sometimes the importer does not recognize the importer account\n- [Issue 8045](https://github.com/firefly-iii/firefly-iii/issues/8045) Bad caching leads to unfixable authentication errors\n- [Issue 8052](https://github.com/firefly-iii/firefly-iii/issues/8052) Credit card transactions after a certain date are not imported while all other transactions are\n- [Issue 8207](https://github.com/firefly-iii/firefly-iii/issues/8207) Data Importer ignoring relevant Nordigen error.\n\n\n## 1.3.8 - 2023-09-02 {#138-2023-09-02}\n\n\n\n### Fixed {#fixed_3}\n- [Issue 7918](https://github.com/firefly-iii/firefly-iii/issues/7918) Make sure XML file are recognized by the POST importer\n\n\n## 1.3.7 - 2023-09-02 {#137-2023-09-02}\n\n\n\n### Fixed {#fixed_4}\n- The POST import command and the CLI import routine will also stop working if the connected Firefly III is too old.\n\n\n## 1.3.6 - 2023-09-02 {#136-2023-09-02}\n\n\n>  ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### Fixed {#fixed_5}\n- [Issue 7891](https://github.com/firefly-iii/firefly-iii/issues/7891) Importing from Spectre has improved, taking into account new API information. This may change the look and feel of your transactions.\n- Some banks would return amount in scientific notation.\n- Several CAMT fixes when the file is missing data.\n- CAMT fix to verify the transaction type.\n- Better flow for the onboarding of new users. Updated the documentation to match.\n\n\n## 1.3.5 - 2023-08-23 {#135-2023-08-23}\n\n\n\n### Fixed {#fixed_6}\n- Error in CSV import would break imports for many users, thanks for reporting!\n- Many null pointers removed from CAMT.053 import.\n\n\n## 1.3.4 - 2023-08-21 {#134-2023-08-21}\n\n\n>  ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### Added {#added_3}\n- Unmapped fields are now sorted at the top for CSV files.\n- Spectre import will include IBAN and name, not just \"name or IBAN\".\n\n\n### Fixed {#fixed_7}\n- Notes are properly trimmed for import\n- Account search will report on its results in the logs\n- Fixed several camt.053 unstructured data import issues.\n- [Issue 7816](https://github.com/firefly-iii/firefly-iii/issues/7816) Importer would break when there was no currency information in a camt file.\n\n\n## 1.3.3 - 2021-07-17 {#133-2021-07-17}\n\n\n\n### Fixed {#fixed_8}\n- Formatting issue in debug log message broke the CAMT import\n\n\n## 1.3.2 - 2023-07-16 {#132-2023-07-16}\n\n\n\n### Added {#added_4}\n- Better error handling for CAMT files.\n\n\n### Changed {#changed_3}\n- New way of saving user info, should make it easier to change variables without running into old values.\n\n\n### Fixed {#fixed_9}\n- [Issue 7729](https://github.com/firefly-iii/firefly-iii/issues/7729) Make sure account type detection can't be overruled by later attempts.\n- [Issue 7747](https://github.com/firefly-iii/firefly-iii/issues/7747) Nullpointer in CAMT import\n\n\n## 1.3.1 - 2021-06-27=8 {#131-2021-06-278}\n\n\n> ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### Changed {#changed_4}\n- This version of the data importer requires Firefly III v6.0.16 or higher.\n\n\n### Fixed {#fixed_10}\n- Many small and large fixes in the new CAMT.053 import routine. Thanks again, @beatbesmer and bug testers!\n- [Issue 7643](https://github.com/firefly-iii/firefly-iii/issues/7643) Bad redirect when trying to import using a config file.\n\n\n## v1.3.0 - 2023-06-05 {#v130-2023-06-05}\n\n\n- ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### CAMT.053 support {#camt053-support}\n\n\nGitHub user @beatbesmer has been working hard to make the data importer support CAMT.053 files. You can now upload\nthese files like you would a CSV file and have them imported into Firefly III. Although this new feature has been\nthorougly tested by Beat and myself, CAMT.053's XML standards are a very loose standard so expect bugs, issues and\ncrashes. We welcome your feedback in the form of [bug reports](https://github.com/firefly-iii/firefly-iii/issues/new?assignees=&labels=&projects=&template=bug.yml)\n\n\n### Added {#added_5}\n- [Issue 6108](https://github.com/firefly-iii/firefly-iii/issues/6108) You can customize the import tag used by the data importer\n\n\n### Fixed {#fixed_11}\n- [Issue 5996](https://github.com/firefly-iii/firefly-iii/issues/5996) Cannot send email using self-signed certificates\n- [Issue 7512](https://github.com/firefly-iii/firefly-iii/issues/7512) Broken links in app and documentation\n- [Issue 7264](https://github.com/firefly-iii/firefly-iii/issues/7264) Data Importer crashes when mail server auth fails\n\n\n## v1.2.2 - 2023-03-19 {#v122-2023-03-19}\n\n\n- ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### Changed {#changed_5}\n- Drop accuracy to 12 decimals. This fixes a lot of rounding issues.\n\n\n### Fixed {#fixed_12}\n- [Issue 7225](https://github.com/firefly-iii/firefly-iii/issues/7225) Fix email error when no vanity url is set\n\n\n## 1.2.1 - 2023-03-13 {#121-2023-03-13}\n\n\n\n### Fixed {#fixed_13}\n- [Issue 7214](https://github.com/firefly-iii/firefly-iii/issues/7214) Previous issue with account currency matching needed a Data Importer fix as well.\n\n\n### Changed {#changed_6}\n- This release will only work with Firefly III v6.0.4\n\n\n## 1.2.0 - 2023-03-13 {#120-2023-03-13}\n\n\n\n### Fixed {#fixed_14}\n- [Issue 7207](https://github.com/firefly-iii/firefly-iii/issues/7207) Missing key validation\n\n\n### Changed {#changed_7}\n- This release will only work with Firefly III v6.0.3\n\n\n## 1.1.0 - 2023-03-12 {#110-2023-03-12}\n\n\n\n### Added {#added_6}\n- Warnings when you use bad configuration values.\n- `IMPORT_DIR_WHITELIST` is now `IMPORT_DIR_ALLOWLIST`\n\n\n### Changed {#changed_8}\n- Improve logging when reporting on possible duplicates.\n\n\n## 1.0.2 - 2022-01-27 {#102-2022-01-27}\n\n\n\n### Fixed {#fixed_15}\n- Missing array key breaks Nordigen and Spectre imports.\n\n\n## 1.0.1 - 2022-01-26 {#101-2022-01-26}\n\n\n\n### Fixed {#fixed_16}\n- Fixed missing options when importing CSV file.\n- Remove `APP_KEY` generation since the data importer doesn't use one.\n\n\n## 1.0.0 - 2022-01-23 {#100-2022-01-23}\n\n\n- ⚠️ This release requires PHP 8.2.\n- ⚠️ This release may create duplicate transactions. Don't import large batches!\n\n\n### Added {#added_7}\n- The data importer has a health checkpoint, thanks @davidschlachter!\n\n\n### Changed {#changed_9}\n- ⚠️ Use Nordigen's internal transaction ID as the transaction ID.\n- Switch to Mastodon in the readme.\n- Fix the link to the PHP docs, thanks @sa7mon!\n- Small fixes to the `.env.example` file, thanks @axelsimon!\n\n\n### Fixed {#fixed_17}\n- [Issue 6518](https://github.com/firefly-iii/firefly-iii/issues/6518) Issue with bad account listings\n- Fix bad method call\n- Make sure CSV import values are trimmed (prevents account names like `PAYPAL    `)\n\n\n## 0.9.17 - 2021-10-24 {#0917-2021-10-24}\n\n\n⚠️ This release WILL create duplicate transactions. Don't import large batches!\n\n\n### Added {#added_8}\n- Better error handling.\n\n\n### Fixed {#fixed_18}\n- Fix [issue 6548](https://github.com/firefly-iii/firefly-iii/issues/6548)\n- Fix [issue 6525](https://github.com/firefly-iii/firefly-iii/issues/6525)\n\n\n## 0.9.16 - 2022-09-12 {#0916-2022-09-12}\n\n\n\n### Added {#added_9}\n- Ability to recognize 'Charge' as a debit transaction.\n- Expand error messages with URL.\n- Log more errors.\n\n\n### Fixed {#fixed_19}\n- [Issue 6354](https://github.com/firefly-iii/firefly-iii/issues/6354) Path fix for subdirectory installations.\n- [Issue 6377](https://github.com/firefly-iii/firefly-iii/issues/6377) Switch issue were transaction amounts were reversed (and thus also the types)\n- [Issue 6412](https://github.com/firefly-iii/firefly-iii/issues/6412) Update for command line import.\n- [Issue 6419](https://github.com/firefly-iii/firefly-iii/issues/6419) Time out and SSL check wasn't consistent.\n\n\n### Security {#security}\n- Update packages\n\n\n## 0.9.15 - 2022-07-25 {#0915-2022-07-25}\n\n\n\n### Fixed {#fixed_20}\n- [Issue 6259](https://github.com/firefly-iii/firefly-iii/issues/6259) Fixed an issue where deposits would not be given a source account.\n\n\n## 0.9.14 - 2022-07-21 {#0914-2022-07-21}\n\n\n\n### Added {#added_10}\n- Fallback to additional information field if description is empty, thanks @martinslota\n\n\n### Fixed {#fixed_21}\n- [Issue 6242](https://github.com/firefly-iii/firefly-iii/issues/6242) Bad string conversion when dates are empty.\n- [Issue 6244](https://github.com/firefly-iii/firefly-iii/issues/6244) Rename field from 'uri' to 'url'.\n- Fix missing field data check for spectre imports.\n\n\n## 0.9.13 - 2022-07-19 {#0913-2022-07-19}\n\n\n\n### Fixed {#fixed_22}\n- Fixed an issue where the importer would break when importing mapped transactions.\n\n\n## 0.9.12 - 2022-07-16 {#0912-2022-07-16}\n\n\n\n### Fixed {#fixed_23}\n- Make sure packages match PHP 8.0\n\n\n## 0.9.11 - 2022-07-16 {#0911-2022-07-16}\n\n\n\n### Fixed {#fixed_24}\n- Issue where config files with empty strings would break the date selection.\n- [Issue 6146](https://github.com/firefly-iii/firefly-iii/issues/6146) Fix issue where missing Nordigen data would break the import.\n- [Issue 6233](https://github.com/firefly-iii/firefly-iii/issues/6233) Fix issue where mapping an expense account to a revenue spot would break the import.\n- Fix issue where the importer would not detect empty descriptions. Thanks @BerghsJelmer\n\n\n## 0.9.10 - 2022-05-03 {#0910-2022-05-03}\n\n\n\n### Changed {#changed_10}\n- Require the most recent version of Firefly III\n\n\n## 0.9.9 - 2022-05-03 {#099-2022-05-03}\n\n\n\n### Changed {#changed_11}\n- Made the texts more generic to accommodate future changes\n- Catch deleted transactions\n- Require most recent Firefly III\n\n\n### Fixed {#fixed_25}\n- [Issue 5980](https://github.com/firefly-iii/firefly-iii/issues/5980) Fix date range.\n\n\n## 0.9.8 - 2022-04-13 {#098-2022-04-13}\n\n\n\n### Fixed {#fixed_26}\n- Fixes an issue with an underlying package.\n\n\n## 0.9.7 - 2022-04-11 {#097-2022-04-11}\n\n\n\n### Fixed {#fixed_27}\n- Fixes an issue with an underlying package.\n\n\n## 0.9.6 - 2022-04-11 {#096-2022-04-11}\n\n\n\n### Fixed {#fixed_28}\n- Fixes an issue with an underlying package.\n\n\n## 0.9.5 - 2022-04-10 {#095-2022-04-10}\n\n\n\n### Fixed {#fixed_29}\n- Fixes an issue with an underlying package.\n\n\n## 0.9.4 - 2022-04-10 {#094-2022-04-10}\n\n\n\n### Fixed {#fixed_30}\n- Fixes another issue with detecting duplicate transactions.\n\n\n## 0.9.3 - 2022-04-05 {#093-2022-04-05}\n\n\n\n### Fixed {#fixed_31}\n\n\n- A small change should make it easier for the data importer to detect failed transaction creation attempts.\n- [Issue 5964](https://github.com/firefly-iii/firefly-iii/issues/5964) Updated libraries to fix issue.\n\n\n## 0.9.2 - 2022-04-02 {#092-2022-04-02}\n\n\n\n### Fixed {#fixed_32}\n- Removed some overly chatty status messages.\n\n\n## 0.9.1 - 2022-04-02 {#091-2022-04-02}\n\n\n\n### Added {#added_11}\n- There is an option to set the maximum days to import from Nordigen, thanks @krehl!\n- Importer will now report expired Nordigen User Agreements, thanks @MacPaille!\n\n\n### Fixed {#fixed_33}\n- [Issue 5871](https://github.com/firefly-iii/firefly-iii/issues/5871) Importer would ignore time-outs\n\n\n## 0.9.0 - 2022-02-22 {#090-2022-02-22}\n\n\n- ⚠️ This release WILL create duplicate transactions. Don't import large batches!\n\n\n### Added {#added_12}\n- Add command to upgrade import configurations.\n\n\n### Changed {#changed_12}\n- Stop logging stack traces to prevent logs from filling up.\n- ⚠️ Don't submit unused `amount_modifier` field\n\n\n### Fixed {#fixed_34}\n- Better error catching in configuration controller and other places.\n- Sanity check to prevent the importer from treating JSON files as CSV files.\n- [Issue 5731](https://github.com/firefly-iii/firefly-iii/issues/5731) Could not import transfers from Spectre\n- [Issue 5735](https://github.com/firefly-iii/firefly-iii/issues/5735) Better support for old import configuration files\n\n\n## 0.8.0 - 2022-02-07 {#080-2022-02-07}\n\n\n- ⚠️ Using Nordigen? This release WILL create duplicate transactions. Don't import large batches.\n\n\n### Added {#added_13}\n- Collect more Nordigen information for future debug.\n- Collect IBAN from secondary source if possible.\n- Add value date as \"payment date\" whenever possible.\n\n\n### Fixed {#fixed_35}\n- [Issue 5590](https://github.com/firefly-iii/firefly-iii/issues/5590) 500 error when attempting to add bank account from Nordigen\n- [Issue 5650](https://github.com/firefly-iii/firefly-iii/issues/5650) Better error catching for timeouts\n- [Issue 5700](https://github.com/firefly-iii/firefly-iii/issues/5700) Missing route for Nordigen (experimental fix)\n- Clean up some logging.\n- Better check on session states\n- Better check on messages to report\n- Will not email if not configured to\n\n\n## 0.7.0 - 2022-01-22 {#070-2022-01-22}\n\n\n- ⚠️ Using Nordigen? This release WILL create duplicate transactions. Don't import large batches.\n\nA special thanks to the excellent folks over at @nordigen for some quick debugging and fixing.\n\n\n### Added {#added_14}\n- A special 500 page so you can see what's happening.\n- Nordigen will now import transaction details in notes.\n- If you have no Firefly III accounts, the importer will warn you.\n- Extra account details debug information.\n\n\n### Fixed {#fixed_36}\n- A missing method broke navigation.\n- Sometimes session details would get lost in translation.\n\n\n## 0.6.5 - 2022-01-15 {#065-2022-01-15}\n\n\n\n### Fixed {#fixed_37}\n\n\n- Catch error in `balanceAfterTransaction` field.\n\n\n## 0.6.4 - 2022-01-15 {#064-2022-01-15}\n\n\n\n### Fixed {#fixed_38}\n\n\n- `ownerAddressUnstructured` could unexpectedly be unset.\n\n\n## 0.6.3 - 2022-01-12 {#063-2022-01-12}\n\n\n\n### Fixed {#fixed_39}\n\n\n- Nordigen reports the `ownerAddressUnstructured` both as string and array, thanks @dawid-czarnecki\n\n\n## 0.6.2 - 2022-01-12 {#062-2022-01-12}\n\n\n\n### Fixed {#fixed_40}\n\n\n- [Issue 5507](https://github.com/firefly-iii/firefly-iii/issues/5507) `ownerAddressUnstructured` field is of the wrong data type.\n- Version 0.6.1 also reports as 0.6.0.\n\n\n## 0.6.1 - 2022-01-08 {#061-2022-01-08}\n\n\n\n### Fixed {#fixed_41}\n\n\n- Missing continue statement in transaction processor\n\n\n## 0.6.0 - 2022-01-08 {#060-2022-01-08}\n\n\n- ⚠️ Duplicate detection could be broken, due to changes in the way transactions are handled. Be careful importing large batches.\n- 💡 Some people have reported running into loops when trying to start importing CSV files. Please [open an issue](https://github.com/firefly-iii/firefly-iii/issues) if this happens to you.\n\n\n### Added {#added_15}\n- The Spectre import checks more fields for payee information, thanks @ddelbondio!\n\n\n### Changed {#changed_13}\n- The importer can stop warning you about duplicate transactions, making for a cleaner import. Check out `.env.example`.\n- If there is nothing to report, there will be no email message.\n- The import tag will not be created until the first transaction is successfully imported.\n- The configuration file export will mention the data importer version.\n\n\n### Fixed {#fixed_42}\n- Various issues where people would end up in a redirect loop.\n- In some cases, the \"mapping\" feature was hidden.\n- The debug page could add newlines, breaking the table.\n- The autoupload endpoint would require CSV files, even when using Nordigen or Spectre.\n- [Issue 5502](https://github.com/firefly-iii/firefly-iii/issues/5502) Sloppy copy/paste bug leads to confusion between the base URL and the vanity URL.\n\n\n## 0.5.0 - 2022-01-01 {#050-2022-01-01}\n\n\n- ⚠️ Duplicate detection could be broken, due to changes in the way transactions are handled. Be careful importing large batches.\n- 💡 Some people have reported running into loops when trying to start importing CSV files. Please [open an issue](https://github.com/firefly-iii/firefly-iii/issues) if this happens to you.\n\n\n### Added {#added_16}\n- Code to support the [cloud installation](https://docs.firefly-iii.org/references/data-importer/public/).\n- Proper page for maintenance mode.\n\n\n### Changed {#changed_14}\n- [Issue 5453](https://github.com/firefly-iii/firefly-iii/issues/5453) Different text for button\n- Importer will complain about bad environment variables.\n- Only create the import tag when necessary.\n\n\n### Fixed {#fixed_43}\n- [Issue 5354](https://github.com/firefly-iii/firefly-iii/issues/5354) Fix edge case when importing CSV files.\n- [Issue 5440](https://github.com/firefly-iii/firefly-iii/issues/5440) Can now handle amounts formatted `0,xxxxx`\n- [Issue 5452](https://github.com/firefly-iii/firefly-iii/issues/5452) Bad vanity URL in reports\n- [Issue 5459](https://github.com/firefly-iii/firefly-iii/issues/5459) Fix issue when skipping configuration page.\n- Filter spaces from IBANs\n\n\n## 0.4.1 - 2021-12-23 {#041-2021-12-23}\n\n\n- ⚠️ Duplicate detection could be broken, due to changes in the way transactions are handled. Be careful importing large batches.\n- 💡 Some people have reported running into loops when trying to start importing CSV files. Please [open an issue](https://github.com/firefly-iii/firefly-iii/issues) if this happens to you.\n\n\n### Added {#added_17}\n- Dark mode. Responds to your browser or OS.\n\n\n### Fixed {#fixed_44}\n- [Issue 5416](https://github.com/firefly-iii/firefly-iii/issues/5416) Mismatch in function name breaks Nordigen.\n\n\n## 0.4.0 - 2021-12-22 {#040-2021-12-22}\n\n\n\n### Known issues {#known-issues}\n\n\n- ⚠️ Duplicate detection could be broken, due to changes in the way transactions are handled. Be careful importing large batches.\n- 💡 Some people have reported running into loops when trying to start importing CSV files. Please [open an issue](https://github.com/firefly-iii/firefly-iii/issues) if this happens to you.\n\n\n### Changed {#changed_15}\n- The importer will search for, and match account numbers as well as IBANs.\n- The importer will prefer 'bookDate' over 'valueDate'\n\n\n### Added {#added_18}\n- POST import and import via upload is now possible. Several mandatory security measures are listed in `.env.example`.\n\n\n### Fixed {#fixed_45}\n- [Issue 5397](https://github.com/firefly-iii/firefly-iii/issues/5397) Could not import into liabilities.\n- [Issue 23](https://github.com/firefly-iii/data-importer/pull/23), fixed date range settings, thanks @p-rintz\n- [Issue 5407](https://github.com/firefly-iii/firefly-iii/issues/5407) Fix issue with empty accountlists.\n\n\n## 0.3.0 - 2021-12-11 {#030-2021-12-11}\n\n\n\n### Added {#added_19}\n- [Issue 5342](https://github.com/firefly-iii/firefly-iii/issues/5342) Can import \"external URL\" field.\n- Will now send report messages over mail if you want.\n\n\n### Fixed {#fixed_46}\n- Remove TODO's from README file.\n- Respect date range when importing.\n- Nordigen will pre-select country + bank\n- Nordigen will recycle requisition\n- Mapping works for Spectre + Nordigen\n- Better secret management for Nordigen + Spectre\n- [Issue 5351](https://github.com/firefly-iii/firefly-iii/issues/5351) Fix URL's\n- Fix duplicate detection.\n- Fix issue with transfers being imported as deposits.\n- New debit indicator thanks to @reeperbahnause\n\n\n## 0.2.0 - 2021-12-04 {#020-2021-12-04}\n\n\n\n### Added {#added_20}\n- There is a `/debug` page if you need it.\n- Auto-import works over the command line.\n- Importing works over the command line.\n- Full documentation in place.\n\n\n### Changed {#changed_16}\n- More consistent layout\n\n\n### Fixed {#fixed_47}\n- [Issue 5336](https://github.com/firefly-iii/firefly-iii/issues/5336) Undefined array key \"Liabilities\n- [Issue 5337](https://github.com/firefly-iii/firefly-iii/issues/5337) Config download fails\n- [Issue 5338](https://github.com/firefly-iii/firefly-iii/issues/5338) APISubmitter not found in RoutineManager\n- [Issue 5339](https://github.com/firefly-iii/firefly-iii/issues/5339) fails to read CSV delimiter correctly\n- [Issue 5343](https://github.com/firefly-iii/firefly-iii/issues/5343) Missing config variable\n- [Issue 5344](https://github.com/firefly-iii/firefly-iii/issues/5344) Protocol mismatch\n- [Issue 5345](https://github.com/firefly-iii/firefly-iii/issues/5345) Some transactions are said to have the same source and destination\n\n\n## 0.1.0 - 2021-11-27 {#010-2021-11-27}\n\n\nFirst release of the data importer.\n\n\n## 0.0.0 - 2021-xx-xx {#000-2021-xx-xx}\n\n\n\n### Added {#added_21}\n- Initial release.\n\n\n### Changed {#changed_17}\n- Initial release.\n\n\n### Deprecated {#deprecated}\n- Initial release.\n\n\n### Removed {#removed}\n- Initial release.\n\n\n### Fixed {#fixed_48}\n- Initial release.\n\n\n### Security {#security_1}\n- Initial release.\n",
      "documentId": "references/data-importer/changelog",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/data-importer/changelog/",
          "markdown": "https://sourcey-firefly.pages.dev/references/data-importer/changelog/index.md"
        }
      ]
    },
    {
      "id": "references/faq/firefly-iii/general/index.md",
      "kind": "page",
      "title": "General Firefly III questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/general/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/general/index.md",
      "file": "references/faq/firefly-iii/general/index.md",
      "searchText": "\n# General Firefly III questions {#general-firefly-iii-questions}\n\n\n\n## Is it multi-user? {#is-it-multi-user}\n\n\nYes. For security reasons Firefly III opens up the registration form only for the first user. See also [how to make Firefly III multi-user](/how-to/firefly-iii/features/multi-user/). Keep in mind that you won't be able to _share_ your administration. This is a work in progress.\n\n\n## Can I share one administration with multiple users? {#can-i-share-one-administration-with-multiple-users}\n\n\nUnfortunately not. Each administration is tightly locked to a single user. If you want to share your financial administration with your partner or somebody else, you must share the username and password with them.\n\n\n## How does it compare to YNAB, Mint, GNUCash, Excel? {#how-does-it-compare-to-ynab-mint-gnucash-excel}\n\n\nThis is a fairly complicated question, but here are some key differences that you should know about.\n\n- Firefly III is self-hosted and geared towards tech-savvy users. You must install it yourself and run it on your own server. This is a huge difference with other financial tools.\n- Importing data from your bank and doing this automatically is not that easy with Firefly III. See also [this introduction about the data importer](/explanation/data-importer/introduction/) for more information.\n- GNUCash has way more \"accounting\" features, like mutual funds and stock and equity.\n- Most online tools like YNAB and Mint have another \"style\" of budgeting money. See for more info, below.\n- There is no desktop app for Firefly III, it's all web based.\n\n\n## Why is Firefly III not based on \"zero-sum budgeting\"? {#why-is-firefly-iii-not-based-on-zero-sum-budgeting}\n\n\nIn many budgeting tools you assign every coin to a budget until all your money is budgeted. When I started Firefly III zero-sum budgeting didn't really exist as a concept, at least not that I remember.\n\nThe only effective difference with YNAB (and other tools) is that you *don't need to budget all the way to zero*. What you do is, you set a monthly amount that you want to budget (aka spend), like € 1000. You shape a few budgets around that amount, and you start the month with € 1000 on your bank account and like 4 budgets to spend it in. Now you have a monthly financial routine around 1000. You can now shape your budgets and try to spend even less. If you have € 2000 on your savings account you know you can go without a job for two months.\n\nAny income you get over the month you put in your savings account directly, it doesn't need to reside on your bank account: it would only muddle your € 1000. If you want to create specific saving targets for the money in your savings account you use [piggy banks](/explanation/financial-concepts/piggy-banks/).\n\nTwo differences between zero-sum budgeting and Firefly III:\n\n- You don't need to budget all the money.\n- You separate the income from the budgeting and spending process\n\nWhen I built Firefly III I was over 5K in debt and this helped me pay it off in less than a year: a monthly budget routine separated from my income, fixed amounts at the start of each month, all income to the savings account. Firefly III is geared towards predetermining your budgets, allocating funds to those budgets *only* and then spend it.\n\nSee [personal finances](/explanation/firefly-iii/background/personal-finances/) for more information.\n\n\n## Will you add AI to Firefly III? {#will-you-add-ai-to-firefly-iii}\n\n\nThe short answer is no.\n\nI've been playing around with AI and Firefly III extensively. Due to the hallucinatory nature of large language models it's absolutely impossible to get this to work reliably and accurately. Which are the two things I want Firefly III to be. \n\nI see of course the added value of trying to categorize transactions based on the data they contain. But this involves either sending your data to the cloud or running a model locally. The first option will not be added to Firefly III, and the second option is not feasible for many people.\n\nAlso, it would be nice to formulate [custom rules](/how-to/firefly-iii/features/rules/) in natural language, but the hard work of parsing the language into a set of database entries that Firefly III can handle still comes to the developer. Unless of course, I accept that the system may hallucinate and do something else entirely. I've also been playing with this it seems very difficult to get AI to build complex rules, which is the only thing you would want to use it for in the first place.\n\nSimilarly, it is not impossible to get an AI to generate the search query you need based on your natural language input. But I don't need to add something to Firefly III to do that: you can build that using any AI tool yourself. \n\nPredicting financial records is notoriously difficult. Firefly III used to have a prediction engine, but it requires financial data (which LLMs can't use anyway) and more meta-data, which Firefly III does not save. Incidental expenses and holiday trips will always mess up the predictions, and there is a lot of data needed to get a feel for somebody's \"life rhythm\". AI's can't predict any better than a human can if the data is not there.\n\nApart from the death/hype spiral that AI is in right now, I do not believe that feeding Firefly III data into a large language model will add quality to the system. It will only add complexity and confusion.\n\nOf course, you can still do this yourself. The Firefly III [API](/how-to/firefly-iii/features/api/) and [webhooks](/how-to/firefly-iii/features/webhooks/) feature allow you to feed anything into anything, and get results back. It should not be hard to add a suggestion engine to Firefly III by simply using a webhook to feed you the suggestions back.\n\n\n## Why does Firefly III not support accounting feature X? {#why-does-firefly-iii-not-support-accounting-feature-x}\n\n\n* Why isn't Firefly III correct, when it comes to expense accounts, revenues and other monetary concepts?\n* Why do you say you support double-entry accounting, when technically you don't?\n\nThe Firefly III financial concepts such as accounts, transactions and what-not are based on what the developer thought was good financial practice when they built Firefly III. It's not entirely (or at all) based on what you would learn in accounting school. The developer is not an accountant, although he kind of pretends to be one. But many things an accountant would expect or find reasonable, may not work or may not be present in Firefly III.\n\nOn [GitHub](https://github.com/firefly-iii/firefly-iii/issues) there have been several discussions on this topic. It's important to know, before you start another one, that the core concepts and possibilities within Firefly III will not change. This includes those weird concepts that make it difficult to manage returns and refunds. \"It's not a bug, it's a feature.\" The developer of Firefly III is well aware of the idiosyncrasies of the system, and pointing them out will not really change their mind. Sorry.\n\nRight now, Firefly III has a lot of history and a lot of work yet to be done to make it ready for the future. Although better support for some common accountancy concepts is one of them, it is not particularly high on the list. Especially since this would also break the fundamental concepts of Firefly III as they are right now, even if they are wrong.\n\nSince this is open source software however, you are in luck. If you feel there is room for \"Firefly III - The Accountant Edition\", feel free [to fork the project and build it](https://github.com/firefly-iii/firefly-iii/fork). The developer will happily link to your project from the Firefly III website and documentation. \n\nSee [personal finances](/explanation/firefly-iii/background/personal-finances/) for more information.\n\n\n## When will you release version (the next version)? {#when-will-you-release-version-the-next-version}\n\n\nAs a rule, I do not comment on the release date of future version. I do this for free in my spare time, so it is difficult to predict when the next version will be released. I do have a [roadmap](https://roadmap.firefly-iii.org), that you can use to guesstimate when the next release will be out.\n\nOn the roadmap, find either Firefly III or the data importer. For the next patch, minor or major version, see if the GitHub tickets that you see (bugs, enhancements or features) are tagged with \"fixed\". If there are many, a new release is probably coming soon.\n\nIt is also common that a new release is followed by several smaller releases, to fix issues.\n\n\n## Will Firefly III support PSD2? {#will-firefly-iii-support-psd2}\n\n\n* Will Firefly III have PSD2 integration?\n* Will Firefly III will be compliant with PSD2?\n\nUnfortunately, there is no such thing as \"PSD2 integration\" or \"PSD2 compliance\". The integration that exists in the real world isn't really feasible for Firefly III.\n\nFirstly, the PSD2 regulation tells banks that they should open their APIs to authorized third parties. These authorized third parties must be registered at national financial institutes like \"De Nederlandse Bank\" (for the Netherlands). Such a registration is of course, impossible for Firefly III.\n\nEach user would have to register their own Firefly III installation separately at the DNB. Keep in mind that this process is expensive. After this registration each bank must authorize you separately. To authorize yourself you will need an EDIAS compliant PSD2 digital certificate which can cost up to EUR 2000 without tax.\n\nIt would cost a lot of time and money to get registered and get the right digital certificates. And even then, these banks have manual processes to allow new API customers and there's no guarantee Firefly III would even make the cut.\n\nSo just getting registered in the context of the PSD2 is impossible for Firefly III.\n\nSecondly. Even if Firefly III was a hosted service (it's not) and it could be registered (it can't be), there is still another problem: the PSD2 doesn't tell banks **how** to open up their APIs. Each bank has their own API with its own authentication flow, API endpoints, data-formats and queries. Literally no bank has the same API. So even if we could register Firefly III at the DBN (we can't) and we could get a PSD2 compliant certificate (we can't), and use the APIs (we can't) we would still have to develop separate applications for each single bank.\n\nFor applications and actual end users like Firefly III and the users that use it, the PSD2 regulation doesn't add any value at all, unfortunately.\n\n\n## Firefly III should be a business! {#firefly-iii-should-be-a-business}\n\n\n* Why is there not a cloud version of Firefly III?\n* Can I just pay you to host Firefly III for me?\n* Where is Firefly III-as-a-Service?\n\nI made Firefly III open source under the AGPL. Making Firefly III open source under the AGPL means that any change or addition to Firefly III must be open sourced under the AGPL as well. And for Firefly III to be business ready it needs a few changes. Those changes will allow anybody to host Firefly III for other people (as a service).\n\n* Firefly III as it is right now requires strict database controls or something auditable outside of Firefly III, because any database administrator can see everybody's administrations. There are no controls in Firefly III against insider threat. That alone makes it totally unworthy of being used in a \"hosted\"-fashion.\n* There is nothing in place to do proper user management, except some half-finished admin pages I built for the demo site 3 years ago. These pages are a part of Firefly III, so if Firefly III breaks so does your user admin.\n* More security and scrutiny is required to ensure the tool is bug-free and hassle-free. It's pretty easy to lock yourself out, for example.\n* There is no payment module or anything; you'd have to develop something on the side.\n* The development pace is too high to offer a stable product. I like to tinker and I break stuff all the time. My users accept this, if begrudgingly. But if they pay AND it breaks? No dice.\n* I built Firefly III specifically because self-hosting is the only way to guarantee your data is (fairly) safe. At least, out of the hands of nefarious corporations. So hosting a public instance for everybody to use is kind of exactly against that idea.\n\nIf you want to, feel free to host Firefly III yourself and sell user accounts. If it's you and a few friends, all the better. You can keep it low-key without needing strict privacy policies or payment services. If there's a kickback for me all the better ;). But make it larger, and I fear you run into the situation where you have to build a second system next to Firefly III to manage users, manage payments, etc. And the parts in Firefly III that you change must be open sourced.\n\nThis excludes all the (legal) work you'll need to have in place to manage other people's finances hassle-free.\n\nPersonally, right now I'm just not interested in turning this into a business. I'm as happy I can be with the way things are right now. Thank you.\n\n",
      "documentId": "references/faq/firefly-iii/general",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/general/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/general/index.md"
        }
      ]
    },
    {
      "id": "references/faq/firefly-iii/using/index.md",
      "kind": "page",
      "title": "Using Firefly III, questions",
      "description": "Press the little red icon in the top menu bar, or disable \"Hidden amounts\" in your /preferences.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/using/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/using/index.md",
      "file": "references/faq/firefly-iii/using/index.md",
      "searchText": "\n# Using Firefly III, questions {#using-firefly-iii-questions}\n\n\n\n## All amounts are zero? {#all-amounts-are-zero}\n\n\nPress the little red icon in the top menu bar, or disable \"Hidden amounts\" in your `/preferences`.\n\n\n## Attempt to read property 'user' on null {#attempt-to-read-property-user-on-null}\n\n\nMake sure your `APP_KEY` is exactly 32 characters. Weird errors may appear otherwise.\n\n\n## Firefly III can't tell the difference between `a` and `ä` {#firefly-iii-cant-tell-the-difference-between-a-and-a}\n\n\nThis happens because by default MySQL can't see the difference. At the moment, I cannot fix this.\n\n\n## Why is the report page showing so many years of presets? It goes back to the year 0025! {#why-is-the-report-page-showing-so-many-years-of-presets-it-goes-back-to-the-year-0025}\n\n\nThis happens when you have one or more transactions imported as \"25\" instead of \"2025\". Firefly III auto-generates the list of reports for you. This list starts with the oldest transaction, and continues until the newest one.\n\nLook at your transactions and correct the oldest one. This will fix it.\n\n\n## I keep getting redirected to the index after editing something {#i-keep-getting-redirected-to-the-index-after-editing-something}\n\n\nIf you're running Firefly III in a reverse proxy environment, please check if you have the following configuration:\n\n```text\nReferrer-Policy: strict-origin\n```\n\nIf this is the case, please change it to:\n\n```text\nReferrer-Policy: same-origin\n```\n\nThat should solve it.\n\n\n## Why is the minimum password length 16 characters? {#why-is-the-minimum-password-length-16-characters}\n\n\nThe minimum password length can't be changed. [NIST](https://pages.nist.gov/800-63-3/sp800-63b.html) recommendations prevail.\n\n\n## Can I sort tables on amount or name? {#can-i-sort-tables-on-amount-or-name}\n\n\nNo, sorry. This is something I hope to fix in a new layout.\n\n\n## I'm running Internet Explorer or Edge and nothing works? {#im-running-internet-explorer-or-edge-and-nothing-works}\n\n\nSome (older) browsers may not work with Firefly III. I have no plans to add support.\n\n* Internet Explorer 9 or lower on Windows 7: will not work.\n* Internet Explorer 10 on Windows 7: works, but modern TLS configurations may break your site (just try [the demo site](https://demo.firefly-iii.org/?mtm_campaign=documentation&mtm_kwd=demo-other)).\n* Internet Explorer 11 on Windows 7: works.\n* Internet Explorer 11 on Windows 8.1: not tested, but should work.\n* Microsoft Edge on Windows 10: will not work due to Content Security Policy header limitations.\n\nFirefly III features very strict Content Security Policy headers that prevent [XSS](https://en.wikipedia.org/wiki/Cross-site_scripting) attacks. However, these headers are pretty new and fancy and Edge and Internet Explorer aren't. So you might run into issues using those browsers.\n\nIn order to make these browsers work, you _may_ change the following environment variable. Edit your `.env` file, or launch your Docker instance with another `-e` added:\n\n`DISABLE_CSP_HEADER=true`\n\nYou do this entirely at your own risk, of course.\n\n\n## I get errors about missing tables, how do I fix this? {#i-get-errors-about-missing-tables-how-do-i-fix-this}\n\n\nA quick check to correct this is to run the following command:\n\n```bash\n# Using Docker?\ndocker exec -it CONTAINERNAME php artisan migrate\n\n# Self managed?\nphp artisan migrate\n```\n\nIf that does not work, or it says \"nothing\" to migrate\" but fails to repair anything, you can try the following two command(s):\n\n```bash\n# Using Docker?\ndocker exec -it CONTAINERNAME php artisan correction:rollback-single-migration\ndocker exec -it CONTAINERNAME php artisan migrate\n\n# Self managed?\nphp artisan correction:rollback-single-migration\nphp artisan migrate\n```\n\nThis will make Firefly III forget it ever tried to execute the last database change, which means it will try again. If the migration was never successfully executed you will see an error. Otherwise, Firefly III will silently skip over the migration.\n\nYou can even do this three or four times, going back a few migrations to find the issue.\n\nIf this does not work, [please see this discussion on GitHub](https://github.com/orgs/firefly-iii/discussions/11672) for a possible solution.\n\n\n## I lost my 2FA token generator, or 2FA has stopped working. {#i-lost-my-2fa-token-generator-or-2fa-has-stopped-working}\n\n\nIf 2FA has stopped working, but it worked before, there probably is a time difference between your 2FA client (your phone) and the server that hosts Firefly III. Fix it. Then try again.\n\nIf you still wish to disable 2FA because it doesn't work, you need to edit the database. Go to the `users` table in your favorite SQL editor, find yourself in the table content and set the value of the `mfa_secret` column to NULL for your user account.\n\nYou can also run this query:\n\n```sql\nupdate users set mfa_secret = NULL where email = \"your@email.com\"\n```\n\nThat should allow you to login again without having to submit a 2FA token.\n\nIf you are using Docker, you can try the following command.\n\n```bash\ndocker exec -it CONTAINERNAME mariadb -ufirefly -p firefly -e 'update users set mfa_secret = NULL where email = \"your@email.com\"'\n```\n\nThe password you need is set in your `.env` file. There is no space between `-u` and `firefly`. If your username or database names are different, make sure you replace them.\n\n\n\n## I want the rules to do something they currently don't support. {#i-want-the-rules-to-do-something-they-currently-dont-support}\n\n\nJust so you know, the Firefly III rule engine is supposed to be basic. That's the goal of the rule engine: to support basic stuff. Although it's _technically_ possible to make the rule engine do the most amazing stuff, I don't want to make Firefly III too complicated. So there are some things the rule engine will never be able to do, even though it's something that's not difficult to program:\n\n* Copy values from one field to another.\n* Boolean logic.\n* Regular expressions.\n* Math\n\n\n## For some reason my balance is off by one cent? {#for-some-reason-my-balance-is-off-by-one-cent}\n\n\nBackup your database. Then run this command:\n\n```text \n# docker users\ndocker exec -it [yourcontainer] php artisan firefly-iii:force-decimal-size\n\n# self-managed users\ncd /your/firefly-iii/directory\nphp artisan firefly-iii:force-decimal-size\n```\n\n\n## I lost my password, but resetting doesn't work {#i-lost-my-password-but-resetting-doesnt-work}\n\n\nThere are two reasons why resetting your password may not work.\n\n1. You signed up using a non-existent email address\n2. You did not configure correct email settings.\n\nYou can correct the second situation using [the email settings](/how-to/firefly-iii/advanced/notifications/).\n\nBy configuring Firefly III to save the email message to the log files (`MAIL_MAILER=log`) *and* [by enabling debug mode](/how-to/general/debug/), any password reset message will be stored to your log files. You can copy/paste the reset link from the email message in the log files.\n\nIf the reset link can no longer be sent, you will have to enter your database to delete all entries from the `password_resets`-table.\n\nAn example of how to do this:\n\n```bash\ndocker exec -i CONTAINER sh -c 'exec echo \"DELETE FROM password_resets;\" | mariadb -u\"DB_USERNAME\" -p\"DB_PASSWORD\"'\n```\n\n```sql\nDELETE FROM password_resets;\n\n```\n\n\n## I changed my email address, and now I can't log in? {#i-changed-my-email-address-and-now-i-cant-log-in}\n\n\nThere are two reasons why changing your email address may not work.\n\n1. You signed up using a non-existent email address\n2. You did not configure correct email settings.\n\nYou have to *confirm* the change to your email address, and if you do not have the magic link from the mail message, this will not work. You can correct the second situation using [the email settings](/how-to/firefly-iii/advanced/notifications/). Then you can reset everything back to normal.\n\nIf you already broke things, use the following database queries to fix it. To learn how to execute them in Docker, please read the previous question.\n\nAfter you run the first query you should be able to login again. Your user ID can be found on the `/profile` page.\n\n```sql\nupdate users set blocked=0, blocked_code=null where email=\"YOUR_NEW_MAIL\"\n\ndelete from preferences where name like \"email_change_%\" and user_id=YOUR_USER_ID;\n```\n\n\n## I get \"Transactions for user #x are off by 0.000000...\" {#i-get-transactions-for-user-x-are-off-by-0000000}\n\n\nThis may happen when importing data.\n\n1. Make a backup of your database. \n2. Run the following command: `php artisan firefly-iii:force-decimal-size`\n\nFor Docker, you'll have to put this in front of it: `docker exec -it [container] (command here)`. The container id can be found using `docker container ls`.\n\n\n## I have a rule that does not work on imported transactions {#i-have-a-rule-that-does-not-work-on-imported-transactions}\n\n\nThere is one [rule action](/references/firefly-iii/rule-actions/) that may not work as expected in combination with the data importer. Any rule action that responds to tags will not respond to the \"custom import tag\" that you can set during your import configuration. \n\nIf you have a [rule](/how-to/firefly-iii/features/rules/) that checks if a tag has a specific value, the custom import tag will be ignored. \n\nThis is because the \"custom import tag\" is not present when a transaction is created by the data importer. It is added later. Since the tag is not yet there when the rule runs, it can't see it and it will be ignored. \n\nThis is by design, and this behavior cannot be changed.\n\n\n## The Host-header does not match the host in the `APP_URL` environment variable? {#the-host-header-does-not-match-the-host-in-the-app_url-environment-variable}\n\n\nThis happens when you run Firefly III behind a reverse proxy, and the reverse proxy does not send the correct `Host` header. This is usually not really a problem, but some security sensitive pages care about this.\n\nMake sure that the URL you visit Firefly III at is also set in `APP_URL`. Example:\n\n```text\nAPP_URL=https://firefly.example.com\n```\n\nRestart your containers (if using Docker) and try again.\n\n\n## My password is not accepted {#my-password-is-not-accepted}\n\n\nFirefly III does not accept short passwords, where short is anything less than 16 characters. If selected, Firefly III will also not accept leaked passwords.\n\nYou can opt to allow leaked passwords to be used, but you cannot use passwords less than 16 characters long.\n",
      "documentId": "references/faq/firefly-iii/using",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/using/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/using/index.md"
        }
      ]
    },
    {
      "id": "references/faq/firefly-iii/finances/index.md",
      "kind": "page",
      "title": "Firefly III personal finance questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/finances/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/finances/index.md",
      "file": "references/faq/firefly-iii/finances/index.md",
      "searchText": "\n# Firefly III personal finance questions {#firefly-iii-personal-finance-questions}\n\n\n\n## I can't set the piggy bank when editing a transaction, only when creating it {#i-cant-set-the-piggy-bank-when-editing-a-transaction-only-when-creating-it}\n\n\nThis 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.\n\n\n## Editing a transaction that is linked to a piggy bank does not change the amount in the piggy bank {#editing-a-transaction-that-is-linked-to-a-piggy-bank-does-not-change-the-amount-in-the-piggy-bank}\n\n\nThe one-time action of adding money to a piggy bank during the creation of the transaction cannot be edited or changed. If you need to put more or less money in the piggy bank, you must do this yourself by going to `/piggy-banks`. If you edit the transaction after you created it, you cannot trigger this action again.\n\n\n## The \"running balance\" column isn't correct {#the-running-balance-column-isnt-correct}\n\n\nSorry, this may happen sometimes. While I try to find the bug, you can correct it by running the following command:\n\n```bash\n# bash and shell:\nphp artisan firefly-iii:refresh-running-balance --force\n\n# Docker\ndocker exec -it <firefly container name> php artisan firefly-iii:refresh-running-balance --force\n```\n\nNote: For the Docker command replace `<firefly container name>` with the correct container name.\n\n\n## What should I do when I close a real life asset account? {#what-should-i-do-when-i-close-a-real-life-asset-account}\n\n\nTo close an account in Firefly III, do the following.\n\n1. The balance must be zero by transferring out or withdrawing the final balance.\n2. Edit the account (look for the pencil icon or use the ellipsis-menu) and remove the checkbox next to **Active**.\n\nYou can find the inactive asset account on a special page: `/inactive-accounts/asset`.\n\nSee [the tutorial on how process a refund](/tutorials/finances/refund/).\n\n\n## How do I set the balance of an account? {#how-do-i-set-the-balance-of-an-account}\n\n\nYou **don't**. You can only influence the balance of an account by actually making or importing transactions that influence the balance. You can't just change the balance of the account.\n\n\n### But then what's the opening balance for? {#but-then-whats-the-opening-balance-for}\n\n\nThe opening balance is meant to set the balance of an account at the **start** of your Firefly III administration. That means that NO earlier transactions exist in your administration, and the opening balance reflects that. It summarizes all the transactions that happened before you started using Firefly III.\n\n\n### My bank automatically rounds transactions up, is that supported? {#my-bank-automatically-rounds-transactions-up-is-that-supported}\n\n\nSome banks will help you save money by rounding amounts up, i.e. from 3.95 to 4.00. The difference is deposited in your savings account. \n\nWhether this is supported depends on how you import and manage transactions.\n\n1. If you create transactions yourself, it's easy to add a split for each transaction. You can also use [this autosave script](https://github.com/JC5/autosave) to help you.\n2. If you import transactions using CSV, GoCardless or another solution, it depends on your bank. Do they create these transactions for you? If so, you're in luck! If not, use [this autosave script](https://github.com/JC5/autosave) to help you.\n\n\n### The charts are annoying! {#the-charts-are-annoying}\n\n\nYes, they are. Especially in two distinct cases:\n\n1. You regularly use two currencies with huge value differences. For example, the Euro versus the Hungarian Forint. Right now, it's about 1 to 380. \n2. You use two or more currencies which are different in value, but maybe not that much. Perhaps the Euro versus the British Pound versus the US Dollar\n\nIn all cases, the Y-axis will always focus on your primary currency (i.e. the Euro) but will scale up to the largest amount (the Hungarian Forint). This may lead to a confusing chart where you believe you're a millionaire but alas, you just own a lot of Forints.\n\nThis is not yet fixed, but I hope to make the charts better in a new release. Thanks for your patience!\n",
      "documentId": "references/faq/firefly-iii/finances",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/finances/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/firefly-iii/finances/index.md"
        }
      ]
    },
    {
      "id": "references/faq/data-importer/general/index.md",
      "kind": "page",
      "title": "General Data Importer questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/general/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/general/index.md",
      "file": "references/faq/data-importer/general/index.md",
      "searchText": "\n# General Data Importer questions {#general-data-importer-questions}\n\n\n\n## I am getting a \"500\"-error, and I don't know what it is! {#i-am-getting-a-500-error-and-i-dont-know-what-it-is}\n\n\nSorry about that. You'll have to consult the data importer log files. Please look at [the debug instructions](/how-to/general/debug/) 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](/explanation/support/), so we can fix it together.\n\n\n## I am being redirected to `http://app` and it doesn't work? {#i-am-being-redirected-to-httpapp-and-it-doesnt-work}\n\n\nMake sure you set the environment variable `VANITY_URL` and make sure it points to your Firefly III installation. You can leave the `FIREFLY_III_URL` to `http://app:8080` as it is supposed to, but make sure that `VANITY_URL` is set to your actual Firefly III URL.\n\nPress \\[Start over\\] in the data importer after you've changed the environment variable.\n\n\n## I am being redirected to `http://localhost` and it doesn't work? {#i-am-being-redirected-to-httplocalhost-and-it-doesnt-work}\n\n\nMake sure you set the environment variable `VANITY_URL` and make sure it points to your Firefly III installation. You can leave the `FIREFLY_III_URL` to `http://app:8080` as it is supposed to, but make sure that `VANITY_URL` is set to your actual Firefly III URL.\n\nPress \\[Start over\\] in the data importer after you've changed the environment variable.\n\n\n## I have another question? {#i-have-another-question}\n\n\nCome [find us for some support](/explanation/support/), so we can add your question!\n",
      "documentId": "references/faq/data-importer/general",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/general/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/general/index.md"
        }
      ]
    },
    {
      "id": "references/faq/data-importer/import/index.md",
      "kind": "page",
      "title": "Common data import issues and questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/import/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/import/index.md",
      "file": "references/faq/data-importer/import/index.md",
      "searchText": "\n# Common data import issues and questions {#common-data-import-issues-and-questions}\n\n\n\n## Firefly III gives a page that says \"Empty\", and nothing else {#firefly-iii-gives-a-page-that-says-empty-and-nothing-else}\n\n\n1. Make sure you **uncheck** the \"Confidential\" checkbox in your OAuth Client settings.\n2. Make sure the port is also present in the `VANITY_URL`, so `http://localhost:9001` (example)\n\n\n## The data importer cannot deal with the amounts in my CSV file. {#the-data-importer-cannot-deal-with-the-amounts-in-my-csv-file}\n\n\nIf 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.\n\n\n## All transactions are imported as today? {#all-transactions-are-imported-as-today}\n\n\nMake sure that the date field in your CSV file (`2023-09-17`) is marked as the \"Transaction\" date, and make sure the format (`Y-m-d`) matches the actual content in the file. Follow the format in [this table](https://www.php.net/manual/en/datetime.format.php).\n\n\n## I get 504 Gateway Timeout errors {#i-get-504-gateway-timeout-errors}\n\n\nWhen you use the web interface of the data importer, the web page will time out after about 600 seconds. Your reverse proxy (if present) may even be more strict. Although the import process continues in the background, the page is \"lost\" and you will not get status updates anymore. Please use smaller batches when importing data so the page does not time out.\n\n\n## Mixed content {#mixed-content}\n\n\nSome banks re-use the columns for different content. For example, \"Sparkasse\" (DE) uses the BIC column for other data if there is no BIC available. If your bank has similar issues, the import will probably fail. The best solution is to ignore the column entirely.\n\n\n## Extra header rows (CSV only) {#extra-header-rows-csv-only}\n\n\nSome banks will insert an extra header-row (`Source,Amount,Destination`) every 100 rows. As if a computer would forget the column names. If your bank does this, those extra header rows will fail during the import.\n\n\n## Not enough info to make rows unique {#not-enough-info-to-make-rows-unique}\n\n\nIf you don't specifically configure the importer to import non-unique rows, open the file in Excel or Numbers and add a row with a basic sequence: 1,2,3,4 etc. That should be enough to make the rows unique.\n\n\n## How do I do mass import for each account with individual config for each account? {#how-do-i-do-mass-import-for-each-account-with-individual-config-for-each-account}\n\n\nYou can do this by using different directories with a `_fallback.json` in each, and triggering the importer with POST requests, including the desired directory in each request.\n\n\n## Missing data? {#missing-data}\n\n\nSome banks do not deliver enough data to make decent imports. You can see this when the following things happen:\n\n- A lot of transactions where the opposing account is called `(no name)`\n- A lot of transactions with `(no description)`\n\nThere is unfortunately not much I can do about it. Here are some tips that I hope will make life easier for you.\n\n\n## Solution: create rules to append transactions {#solution-create-rules-to-append-transactions}\n\n\nEven when there is the tiniest bit of information in your transactions, you can use the rule engine to append the transactions\nand make them more complete. For example:\n\n- If the description contains `SPRMKT`, set the description to `Groceries` and set the destination account to `Supermarket`.\n- Every transaction of exactly `6.00` is probably Starbucks\n\n\n## Solution: Destination / expense accounts {#solution-destination--expense-accounts}\n\n\nSome users make expense accounts for stores. You can also group transactions under \"Groceries\" and \"Restaurant\" and call it a day.\n",
      "documentId": "references/faq/data-importer/import",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/import/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/import/index.md"
        }
      ]
    },
    {
      "id": "references/faq/data-importer/gocardless/index.md",
      "kind": "page",
      "title": "GoCardless",
      "description": "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!",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/gocardless/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/gocardless/index.md",
      "file": "references/faq/data-importer/gocardless/index.md",
      "searchText": "\n# GoCardless {#gocardless}\n\n\n\n## When I delete a transaction, it is imported again? {#when-i-delete-a-transaction-it-is-imported-again}\n\n\nThe 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!\n\nCheck out your configuration file. You have a line that says `\"ignore_duplicate_transactions\":`. Make sure that the value is `true`.\n\n\n## Is it possible to import from multiple banks? {#is-it-possible-to-import-from-multiple-banks}\n\n\nYes, this is possible. In both cases, you'll have to run the data importer a few times (once for each bank) and save the configuration file. Make sure you rename it to something useful like \"your-bank.json\". Use the file during your next run of the data importer.\n\nIf the data importer caches something, please make sure to press \"Start Over\" before you import from the next bank.\n\n\n## GoCardless imports weird transactions? {#gocardless-imports-weird-transactions}\n\n\nThis question covers the issue of GoCardless doing something weird. First, it imports transactions\n\n- from the future\n- with the wrong details\n- with missing details\n\n... or with other strange details. Then, at a later moment, it comes around and imports the correct version of those particular transactions. This leaves you with double transactions and missing details.\n\nThis is no something the data importer can prevent, but you can automatically remove those transactions by creating a rule that deletes all transactions that have the `pending`-tag. The [rules page](/how-to/firefly-iii/features/rules/) has more details about rules.\n\n\n## I have a rule that does not work on imported transactions {#i-have-a-rule-that-does-not-work-on-imported-transactions}\n\n\nThere is one [rule action](/references/firefly-iii/rule-actions/) that may not work as expected in combination with the data importer. Any rule action that responds to tags will not respond to the \"custom import tag\" that you can set during your import configuration.\n\nIf you have a [rule](/how-to/firefly-iii/features/rules/) that checks if a tag has a specific value, the custom import tag will be ignored.\n\nThis is because the \"custom import tag\" is not present when a transaction is created by the data importer. It is added later. Since the tag is not yet there when the rule runs, it can't see it and it will be ignored.\n\nThis is by design, and this behavior cannot be changed.\n\n\n## I am rate limited by GoCardless! {#i-am-rate-limited-by-gocardless}\n\n\nRecently, GoCardless introduced rate limits. You can read about it on [their website](https://bankaccountdata.zendesk.com/hc/en-gb/articles/11529584398236-Bank-API-Rate-Limits-and-Rate-Limit-Headers). Depending on the number of banks, and the number of accounts you want to import from you will run into the rate limits.\n\nI cannot fix this for you. The data importer tries to use as few requests as possible. Please do not open issues about this. The data importer (v1.5.6 and up) can handle the rate limits. Other versions may give you cryptic errors.\n\nWhen this feature was introduced, it was possible to see some weird things, like rate limits not resetting or the rate limit reset time being a negative number of hours. These are all issues with GoCardless, not with the data importer. Please contact GoCardless support if you run into these issues. \n\nGenerally speaking, the time you need to wait is correct. If the time to wait is less than 5 minutes, the data importer will wait for you. If it will take longer, the data importer cannot \"wait it out\" for you. You must wait yourself for the rate limit to reset. If you keep hammering GoCardless, you may be banned.\n",
      "documentId": "references/faq/data-importer/gocardless",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/data-importer/gocardless/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/data-importer/gocardless/index.md"
        }
      ]
    },
    {
      "id": "references/faq/general/index.md",
      "kind": "page",
      "title": "General questions and answers",
      "description": "Some questions don't really fit anywhere, so I have put them in this section.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/general/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/general/index.md",
      "file": "references/faq/general/index.md",
      "searchText": "\n# General questions and answers {#general-questions-and-answers}\n\n\nSome questions don't really fit anywhere, so I have put them in this section.\n\n\n## My feature or change request is too specific, what do you mean by that? {#my-feature-or-change-request-is-too-specific-what-do-you-mean-by-that}\n\n\nSometimes there is a feature request for Firefly III that could be a great addition to Firefly III, but it is just too specific. That means it is a request for a feature that is used by too few people, or that is so specific that it is not useful for a reasonable number of users.\n\nIt is also possible that such a request solves a very specific problem for a small group of users.\n\nI must apologize, but such requests are generally not honored. The requested change will not be made, and I will also not accept a PR to fix it.\n\nIn this FAQ answer, allow me to explain when a feature request is too specific:\n\nAs a general rule, a feature or an enhancement has to make peoples lives better by virtue of existing. For example, Firefly III allows you to quick-select a quarterly report range. The data importer connects to a variety of third party importers. That is useful. Even if you don't use it. You know what it does and why it is there. Opposed to that, many requested features or changes follow this pattern:\n\n1. A user runs into a problem, Problem X.\n2. To solve the problem, a new feature or option is proposed, to prevent them (and others) from running into Problem X.\n3. It is _impossible_ for you to appreciate or understand the new feature until you also run into Problem X, at which point you must:\n    1. Learn that this is in fact \"Problem X\".\n    2. Learn from the documentation or by sheer will that this has been fixed in the past, and has a solution.\n    3. Apply the solution to your Problem X, by changing the setting or using the new feature.\n    4. Undo whatever you did previously, and do it again but this time with the fix for Problem X applied.\n\nAs you can read, an important check for me to refuse feature requests for \"Problem X\"-type of issues is if you first need to run into Problem X. That in itself is not an issue. If the proposed solution to \"Problem X\" is not obviously to helpful or understandable to users who will never run into \"Problem X\" the feature is too specific.\n\nWhen all the Problem Xs gets solved all the time by way of new features and settings, it means that Firefly III will become a mass of features, options, settings, choices and enhancements. None of those will bring value to the end user until they actually run into the associated problem and make the mental leap to the existing solution. \n\nI've seen this destroy other product's usability and usefulness. They tend to become a massive pile of check boxes, system settings, environment variables and tutorials to make the product do _exactly and only exactly_ what you want. \n\nDoing this to Firefly III or the data importer would enormously increase the maintenance and support burden, because each and every new feature must be maintained, tested and documented. All the while, people will continue to ask about \"Problem X\", unaware that a solution exists (because nobody ever reads documentation). As a bonus, I fear that many people will apply the wrong solution to \"Problem X\" and run into even more problems, greatly increasing the maintenance and support burden.\n\nI try to prevent Firefly III from becoming such a product. It will remain itself, with missing features and missing options. But whatever options it offers, I hope they make sense and that they will be useful. That means that the product does not exactly do what you need it to do. Sorry about that.\n",
      "documentId": "references/faq/general",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/general/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/general/index.md"
        }
      ]
    },
    {
      "id": "references/faq/install/index.md",
      "kind": "page",
      "title": "General installation and running questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/install/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/install/index.md",
      "file": "references/faq/install/index.md",
      "searchText": "\n# General installation and running questions {#general-installation-and-running-questions}\n\n\n\n## I cannot reach Firefly III directly using its ipv6 address! {#i-cannot-reach-firefly-iii-directly-using-its-ipv6-address}\n\n\nNo 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.\n\n\n## Key path oauth-private.key does not exist or is not readable? {#key-path-oauth-privatekey-does-not-exist-or-is-not-readable}\n\n\nIf this file does not exist, you can run the following command:\n\n```bash\nphp artisan passport:install\n```\n\nAfterwards, you can run the following commands to fix the permissions.\n\n```bash\nphp artisan config:clear\nphp artisan key:generate\nphp artisan config:clear\n```\n\nAnd then:\n\n```bash\nsudo chown www-data:www-data storage/oauth-*.key\nsudo chmod 600 storage/oauth-*.key\n```\n\n## I want to build the Firefly III release myself {#i-want-to-build-the-firefly-iii-release-myself}\n\n\nIf you want to build the Firefly III release yourself, you can use the following commands. Clone the repository, and then run this. These commands will install all necessary dependencies and build the generated JS code.\n\n```bash\ncomposer install --no-dev\nnpm install\nnpm run prod  --workspace=v1\nnpm run build --workspace=v2\n```\n\n\n## I want to build the Data Importer release myself {#i-want-to-build-the-data-importer-release-myself}\n\n\nIf you want to build the Firefly III Data Importer release yourself, you can use the following commands. Clone the repository, and then run this. These commands will install all necessary dependencies and build the generated JS code.\n\n```bash\ncomposer install --no-dev\nnpm install\nnpm run build --workspace=v2\n```\n\n\n## Unexplainable 431 errors {#unexplainable-431-errors}\n\n\nFirst, make sure that your reverse proxy has a large enough maximum header size, or specific actions (such as logging in) fail. If you run something like Authelia, make sure the buffer size is set to at least 8192.\n\n\n## Error \"class \\[auth\\] does not exist\" {#error-class-auth-does-not-exist}\n\n\n- Target class \\[hash\\] does not exist.\n\nSome users run into this issue when upgrading. Several things may work:\n\n- Start a new `.env` file instead of copying over the old one.\n- Make sure the `storage` directory, and all subfolders are writable, and NOT owned by `root`.\n- Remove all PHP files from the `bootstrap/cache` directory: `rm bootstrap/cache/*.php`.\n\n\n## Charts are not loading, and `email-decode.min.js` refuses to load? {#charts-are-not-loading-and-email-decodeminjs-refuses-to-load}\n\n\nYou are using Cloudflare as a CDN. Please disable \"email obfuscation\".\n\n\n## Can I switch from or to SQLite, PostgreSQL or MySQL? {#can-i-switch-from-or-to-sqlite-postgresql-or-mysql}\n\n\nYes, any combination is possible. BUT, this is not something that Firefly III supports natively. The export function isn't \"database complete\", not all data from your installation will be exposed when you export data, so importing it is very tricky.\n\nInstead, use a search engine to find the right guidance to migrate from A to B, whichever databases A and B may be.\n\n\n## Can I connect to PostgreSQL using a socket? {#can-i-connect-to-postgresql-using-a-socket}\n\n\nYes. Set `DB_HOST` to the `unix_socket_directory` of PostgreSQL.\n\n```text\nDB_CONNECTION=pgsql\nDB_HOST=/run/postgresql\nDB_PORT=5432\n```\n\n\n## How do I set TLS in Firefly III or the data importer? {#how-do-i-set-tls-in-firefly-iii-or-the-data-importer}\n\n\nIf you wish to enable SSL as well, both apps respects the HTTP header `X-Forwarded-Proto`.\n\nIf you are using Nginx add the following to your location block:\n\n```text\nproxy_set_header X-Forwarded-Proto $scheme;\nproxy_set_header X-Forwarded-Host $host;\nproxy_set_header X-Forwarded-Server $host;\nproxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;\nproxy_set_header Host $host;\n# This line is optional and may help in some cases.\n# proxy_set_header X-Forwarded-Port $server_port;\nclient_max_body_size 64M;\nproxy_read_timeout 300s;\n```\n\nFor Apache, use something like:\n\n```text\n<VirtualHost *:443>\n        ServerName firefly.mydomain.com\n        ServerAdmin EMAIL\n        ProxyPreserveHost On\n        ProxyRequests Off\n        SSLEngine On\n        SSLCertificateFile      /etc/letsencrypt/live/.../fullchain.pem\n        SSLCertificateKeyFile   /etc/letsencrypt/live/.../privkey.pem\n        ProxyPass / http://127.0.0.1:8080/\n        ProxyPassReverse / http://127.0.0.1:8080/\n        ErrorLog ${APACHE_LOG_DIR}/finance_error.log\n        CustomLog ${APACHE_LOG_DIR}/finance_access.log combined\n        RequestHeader set X-Forwarded-Proto expr=%{REQUEST_SCHEME}\n        RequestHeader set X-Forwarded-SSL expr=%{HTTPS}\n</VirtualHost>\n```\n\n\n## I can't seem to get https working {#i-cant-seem-to-get-https-working}\n\n\nSet `TRUSTED_PROXIES` to `*`. See also [this issue](https://github.com/firefly-iii/firefly-iii/issues/1632) on GitHub.\n\n\n## I get \"Function not implemented: AH00141: Could not initialize random number generator\" {#i-get-function-not-implemented-ah00141-could-not-initialize-random-number-generator}\n\n\nThis is an error that happens on Synology boxes with an old kernel. I'm sorry, there is nothing I can do for you.\n\n\n## How do I configure a reverse proxy in Docker? {#how-do-i-configure-a-reverse-proxy-in-docker}\n\n\nTo run the data importer behind a reverse proxy, make sure you set the `TRUSTED_PROXIES` environment variable to either `*` or the IP address of your reverse proxy.\n\n\n## I can't get beyond the opening screen {#i-cant-get-beyond-the-opening-screen}\n\n\nSome setups have a bad time handling cookies, and without support for cookies the Data Importer doesn't know what you want to do. Make sure that\n\n- You don't run the data importer in a subdirectory\n- The cookie settings in the `.env` file are correct.\n\n\n## 502 Bad Gateway errors {#502-bad-gateway-errors}\n\n\nWhen Firefly III responds with a token, the resulting header may be too long for your reverse proxy.\nThese lines prevent that the proxy buffer size is too small. Put it in the `server` block of your nginx server.\n\n```\nserver {\n    ...\n    proxy_buffer_size       128k;\n    proxy_buffers           4 256k;\n    proxy_busy_buffers_size 256k;\n}\n```\n\nIf that doesn't help, try:\n\n```\nserver {\n    ...\n    fastcgi_buffers  16 16k;\n    fastcgi_buffer_size  32k;\n    \n}\n```\n\n\n## Response header name contains invalid characters, aborting request {#response-header-name-contains-invalid-characters-aborting-request}\n\n\nHappens to some Apache servers when they are not configured correctly. Set `LOG_LEVEL=emergency`.\n\n\n\n## I get an error about openssl\\_pkey\\_export? {#i-get-an-error-about-openssl_pkey_export}\n\n\nIt means your machine has no proper configuration file for OpenSSL, or it cannot be found. Please check out [this GitHub issue](https://github.com/firefly-iii/firefly-iii/issues/1384) for tips and tricks.\n\n\n\n## I get syntax errors or other problems when opening Firefly III? {#i-get-syntax-errors-or-other-problems-when-opening-firefly-iii}\n\n\nYou're not running the correct version of PHP, or your Apache / nginx server is not correctly configured for the right PHP version. At the moment, you need **PHP %PHPVERSION**.\n\nErrors you can expect to see if you're not running **PHP %PHPVERSION**:\n\n1. `Syntax error, unexpected )`\n2. `syntax error, unexpected 'string' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)`\n3. `Unexpected question mark`\n\nYou can verify which version of PHP your web server is using by making a file called `phpinfo.php` and browsing to it through your webserver:\n\n```php\n<?php\nphpinfo();\n```\n\nThat should tell you what you need to know. You can find update and upgrade instructions online for your web server.\n\n\n\n\n## Firefly III is very slow {#firefly-iii-is-very-slow}\n\n\nTry the following suggestions.\n\n- From discussion [#5051](https://github.com/firefly-iii/firefly-iii/discussions/5051): Add `fastcgi_buffering off;` to the `server {}` section of your nginx configuration.\n\n\n## I have to visit Firefly III through /public/ and it gives me a warning? {#i-have-to-visit-firefly-iii-through-public-and-it-gives-me-a-warning}\n\n\nThis means that the Document Root of your webserver is badly configured. You should configure your webserver in such a way that `/` corresponds to `/public`. If you do not, you run the risk of exposing your database credentials, sessions and other sensitive financial data to the world.\n\nThere are several [tutorials online](https://www.digitalocean.com/community/tutorials/how-to-move-an-apache-web-root-to-a-new-location-on-ubuntu-16-04) that explain how to change your document root.\n\n\n## I am using nginx and want to expose Firefly III under /budget/ {#i-am-using-nginx-and-want-to-expose-firefly-iii-under-budget}\n\n\nThe following snippet might help:\n\n```text\nlocation ^~ /firefly-iii/ {\n   deny all;\n}\n\nlocation ^~ /budget {\n   alias /var/www/html/firefly-iii/public;\n   try_files $uri $uri/ @budget;\n\n   location ~* \\.php(?:$|/) {\n      include snippets/fastcgi-php.conf;\n      fastcgi_param SCRIPT_FILENAME $request_filename;\n      fastcgi_param modHeadersAvailable true; #Avoid sending the security headers twice\n      fastcgi_pass unix:/run/php/php%PHPVERSION-fpm.sock;\n   }\n}\n\nlocation @budget {\n   rewrite ^/budget/(.*)$ /budget/index.php/$1 last;\n}\n```\n\n\n## I want to use SQLite? {#i-want-to-use-sqlite}\n\n\nOpen your `.env` file and find the lines that begin with `DB_`. These define your database connection. Leave `DB_CONNECTION` and set it to `sqlite`. Delete the rest.\n\n```text\nDB_CONNECTION=sqlite\n```\n\nThe Docker container will fix the database file for you. If you are not using Docker, you must make sure the file exists. For example:\n\n```text\n# do NOT do this when you are using Docker or Podman or whatever.\ntouch ./storage/database/database.sqlite\n```\n\nThe Docker container will install the database for you. If you are not using Docker, you must do this yourself.\n\n```text\n# only if not on Docker\nphp artisan migrate --seed\nphp artisan firefly-iii:upgrade-database\n```\n\nDocker Compose users must remove the entire \"db\" block from their `docker-compose.yml`-file, since it is no longer necessary. However, they must ADD the following line to their `docker-compose.yml` file OR to whatever Docker configuration they have:\n\n```\n    volumes:\n      - firefly_iii_upload:/var/www/html/storage/upload\n      - firefly_iii_database:/var/www/html/storage/database\n```\n\nThe line that says \"upload\" may exist already. \n\nAlso remove the dependency on the `db` container:\n\n```\n    depends_on:\n      - db\n```\n\n\n\n## I want to use PostgreSQL? {#i-want-to-use-postgresql}\n\n\nIn your `.env` file, change the `DB_CONNECTION` to `pgsql`. Update the other `DB_*` settings to match your database settings. The default port for PostgreSQL is 5432.\n\nThen you are ready to install the database in PostgreSQL:\n\n```text\nphp artisan migrate --seed\nphp artisan firefly-iii:upgrade-database\n```\n\nDocker Compose users must also take care to update the Docker compose file to use the correct PostgreSQL image. For example:\n\n```\n  db:\n    image: postgres:18\n    hostname: db\n```\n\nIf you already have a PostgreSQL server running, you may remove the entire \"db\" block from your `docker-compose.yml` file.\n\nIf you use PostgreSQL instead of MySQL you must also take care to update the environment variables in `.db.env`.\n\nCheck out [this GitHub discussion](https://github.com/orgs/firefly-iii/discussions/7698#discussioncomment-6546883) for a guide to migrate.\n\n\n\n## I see a white page and nothing else? {#i-see-a-white-page-and-nothing-else}\n\n\nCheck out the log files in `storage/logs` to see what is going on. Please open a ticker if you are not sure what to do. If the logs are empty Firefly III cannot write to them. The web server must have write permissions in this directory. If the logs still remain empty, do you have a `vendor` directory in your Firefly III root? If not, run the Composer commands.\n\nIf the pages remain empty, check the rewrite module in Apache. If you're running nginx, use this as the \"location\" config:\n\n```text\nlocation / {\n     try_files $uri $uri/ /index.php?$query_string;\n     autoindex on;\n     sendfile off;\n}\n```\n\n\n## I get a 404? {#i-get-a-404}\n\n\nIf you run Apache, open the `httpd.conf` or `apache2.conf` configuration file (its location differs, but it is probably in `/etc/apache2`).\n\nFind the line that starts with `<Directory /var/www>`. If you see `/`, keep looking!\n\nYou will see the text `AllowOverride None` right below it. Change it to `AllowOverride All`.\n\nAlso run the following commands:\n\n```text\nsudo a2enmod rewrite\nsudo service apache2 restart\n```\n\nThat should fix it!\n\n\n## I get \"Be right back\"? {#i-get-be-right-back}\n\n\nUnfortunately, there is no straight answer without more information. Check out the `/storage/logs` directory of your Firefly III installation or check the logs of your Docker instance. The true error will be reported there. If necessary, enable [debug mode](/how-to/general/debug/) to collect more log files.\n\n\n## Can I use it on PHP, but not version %PHPVERSION? {#can-i-use-it-on-php-but-not-version-phpversion}\n\n\nNo. The code has been written specifically for PHP version %PHPVERSION and higher.\n\n\n\n\n\n## It is very slow on my server? {#it-is-very-slow-on-my-server}\n\n\nRaspberry Pi's and other microcomputers are not the most speedy devices. User [ndandanov](https://github.com/ndandanov) has very kindly tested what works best, and found out that [installing PHP OpCache is a very good way to speed up Firefly III](https://github.com/firefly-iii/firefly-iii/issues/1095#issuecomment-356975735).\n\n\n## Decimal points are missing, numbers are off? {#decimal-points-are-missing-numbers-are-off}\n\n\nSee \"[Locales](/how-to/firefly-iii/advanced/locales/)\".\n\n\n## I get 'BCMath' errors? {#i-get-bcmath-errors}\n\n\nYou see stuff like this:\n\n```text\nPHP message: PHP Fatal error: Call to undefined function \nFireflyIII\\Http\\Controllers\\bcscale() in\nfirefly-iii/app/Http/Controllers/HomeController.php on line 76\n```\n\nSolution: you haven't enabled or installed the BCMath module. Install it.\n\n\n## I get 'intl' errors? {#i-get-intl-errors}\n\n\nErrors such as these:\n\n```text\nproduction.ERROR: exception \n'Symfony\\Component\\Debug\\Exception\\FatalErrorException' with message\n'Call to undefined function FireflyIII\\Http\\Controllers\\numfmt_create()'\nin firefly-iii/app/Http/Controllers/Controller.php:55\n```\n\nSolution: You haven't enabled or installed the Internationalization extension. If you are running FreeBSD, install `pecl-intl`.\n\n\n## I get 'Error: Call to undefined function ctype\\_alpha()'? {#i-get-error-call-to-undefined-function-ctype_alpha}\n\n\nThis may happen when you are on a NAS4free Debian installation or similar platform. This command may help:\n\n```text\npkg install php82-ctype\n```\n\n\n## I get 'Error: could not open input file artisan'? {#i-get-error-could-not-open-input-file-artisan}\n\n\nRun the artisan commands in the `firefly-iii` directory.\n\n\n## I get 'Error: call to undefined function numfmt\\_create()'? {#i-get-error-call-to-undefined-function-numfmt_create}\n\n\nVerify you have installed and enabled the PHP intl extension.\n\n\n## I run SELinux and I don't want to disable it. Now what? {#i-run-selinux-and-i-dont-want-to-disable-it-now-what}\n\n\nReddit-user [bousquetfrederic](https://www.reddit.com/user/bousquetfrederic) shares [their solution](https://www.reddit.com/r/FireflyIII/comments/84bf0p/selinux_vs_fireflyiii/):\n\n```bash\nsudo semanage fcontext -a -t httpd_sys_rw_content_t \"/path/to/firefly-iii/storage(/.*)?\"\nsudo restorecon -R /path/to/firefly-iii/storage\n```\n\n\n## I am trying to upgrade, but I get \"Foreign key constraint is incorrectly formed\" {#i-am-trying-to-upgrade-but-i-get-foreign-key-constraint-is-incorrectly-formed}\n\n\nThis could happen when you upgrade a Firefly III installation with MySQL. To fix this, use a program like Sequel Pro or phpMyAdmin and change the engine of all your Firefly III tables to \"InnoDB\", _before_ you try to upgrade.\n\n\n## Unable to write to cache directory? {#unable-to-write-to-cache-directory}\n\n\nThis is a permissions error that may happen when another user than your webserver user has write permissions in the Firefly III installation directory. Try the following command from your `/var/www/` directory:\n\n* `sudo chown -R www-data:www-data firefly-iii`\n* `sudo chmod -R 775 firefly-iii`\n\nIf you're using Docker, this may also happen when you run \"php artisan\" commands as root. To fix this, you can use a similar command for Docker. Replace `<container>` with the ID of your container.\n\n* `docker exec -it <container> chown -R www-data:www-data /var/www/html/storage`\n\nIf the problem persists run your cron job as the \"www-data\" user so the cache directory doesn't get mixed up: `sudo -u www-data php artisan [..]`.\n\n\n## Key path \"oauth-public.key\" does not exist or is not readable {#key-path-oauth-publickey-does-not-exist-or-is-not-readable}\n\n\nThis happens on some Docker installations and sometimes in Proxmox. I still don't know the exact root cause for this, but the solution could be to run the following command, either on the command line (where you installed Firefly III) or inside the container that is running Firefly III\n\n* `php artisan firefly-iii:laravel-passport-keys`\n* `docker exec -it (container) php artisan firefly-iii:laravel-passport-keys`\n\nWithout those files in place and readable, Firefly III will not be able to function properly.\n",
      "documentId": "references/faq/install",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/install/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/install/index.md"
        }
      ]
    },
    {
      "id": "references/faq/development/index.md",
      "kind": "page",
      "title": "Development",
      "description": "If you want to contribute to the development of Firefly III, first of all: thank you!",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/development/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/development/index.md",
      "file": "references/faq/development/index.md",
      "searchText": "\n# Development {#development}\n\n\nIf you want to contribute to the development of Firefly III, first of all: thank you!\n\nPlease read the [contribution rules](/explanation/support/) and please also read about [Firefly III's architecture](/explanation/more-information/architecture/).\n\n\n## Languages {#languages}\n\n\n\n### Firefly III {#firefly-iii}\n\n\n- Firefly III is written in PHP %PHPVERSION.\n- The current, v3-layout uses Blade (PHP) and AlpineJS. Several parts of this layout still use vanilla JS\n\n\n### Data Importer {#data-importer}\n\n\n- The Data Importer is written in PHP %PHPVERSION\n- The layout uses Blade templates and AlpineJS.\n\n\n## Development environment {#development-environment}\n\n\nFor PHP, you're on your own. Use [Laravel Homestead](https://laravel.com/docs/11.x/homestead) or [Vagrant](https://www.vagrantup.com/) to set up a VM, or use a custom setup with Apache or nginx. Personally, I use a custom-built Vagrant vm.\n\n\n## Code structure {#code-structure}\n\n\nThis chapter details the code structure, so you know where to start.\n\n\n### Frontend {#frontend}\n\n\nFirefly III features two workspaces, detailed in `package.json`. Here you also find references to where the sources are, and the `package.json` details the commands you can run.\n\nThe data importer does not feature multiple layouts, but it does have a workspace reference in the `package.json`-file. There is only one workspace (only the `v2`-layout is used) and the sources are listed there. \n\n\n### Backend {#backend}\n\n\nThe code structure for the backend is explained on the [architecture](/explanation/more-information/architecture/) page. The data importer has a similar structure. \n\n\n### API {#api}\n\n\nFirefly III has an API. The code is in the `/app/Api`-directory. The routes and structure of the API are listed in `routes/api.php`. \n\n\n## Building Firefly III {#building-firefly-iii}\n\n\nTo build the frontend of Firefly III, run the following commands.\n\n```text\nnpm install\nnpm run build --workspace=v3\n```\n\nTo install the dependencies, run:\n\n```text\ncomposer update --no-dev --no-scripts --no-plugins\n```\n",
      "documentId": "references/faq/development",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/development/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/development/index.md"
        }
      ]
    },
    {
      "id": "references/faq/docker/index.md",
      "kind": "page",
      "title": "FAQ for Docker-related questions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/references/faq/docker/",
      "markdown": "https://sourcey-firefly.pages.dev/references/faq/docker/index.md",
      "file": "references/faq/docker/index.md",
      "searchText": "\n# FAQ for Docker-related questions {#faq-for-docker-related-questions}\n\n\n\n## Where is the Dockerfile? {#where-is-the-dockerfile}\n\n\n- [Firefly III](https://dev.azure.com/Firefly-III/_git/MainImage?path=/Dockerfile)\n- [Firefly III Data Importer](https://dev.azure.com/Firefly-III/_git/ImportToolImage)\n- [Firefly III shared base image \\(web\\)](https://dev.azure.com/Firefly-III/_git/BaseImage?path=/Dockerfile.web) and [Firefly III shared base image \\(cli\\)](https://dev.azure.com/Firefly-III/_git/BaseImage?path=/Dockerfile.cli)\n\n\n## Which Docker tags are available? {#which-docker-tags-are-available}\n\n\nThe instructions always assume `fireflyiii/core:latest`. This is the latest stable release. Other tags are:\n\n* `fireflyiii/core:beta`. This tag contains beta releases.\n* `fireflyiii/core:alpha`. This tag contains alpha releases.\n* `fireflyiii/core:develop`. Always the latest develop image. Maybe unstable.\n\n\n## Can I use Docker secrets? {#can-i-use-docker-secrets}\n\n\nYes, 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](https://forums.docker.com/t/only-root-user-has-access-to-the-secret/102774) and detailed [in this GitHub discussion](https://github.com/orgs/firefly-iii/discussions/9788).\n\n\n## I get \"Auth driver \\[remote_user_guard\\] for guard \\[remote_user_guard\\] is not defined\" {#i-get-auth-driver-remote_user_guard-for-guard-remote_user_guard-is-not-defined}\n\n\nPlease make sure your `APP_KEY` is exactly 32 characters long. You can generate such a key with the following command:\n\n```bash \nhead /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 32 && echo\n```\n\n\n## For which platforms the Firefly III Docker image built? {#for-which-platforms-the-firefly-iii-docker-image-built}\n\n\nAll Docker tags are built for `linux/amd64` and `linux/arm64`. Others, like `linux/386`, `linux/arm/v6` and `linux/arm/v7` are no longer supported, so these images will *not* work on the Raspberry Pi Zero, Raspberry Pi 1 (A+B) or Raspberry Pi Compute Module.\n\nIt is still possible to run and use Firefly III on these platforms (and other devices), but because of the maintenance and security burden that comes with supporting many platforms, I've opted not to supprt them any more.\n\n\n## How do I set TLS in Firefly III or the data importer? {#how-do-i-set-tls-in-firefly-iii-or-the-data-importer}\n\n\nSee [this question](/references/faq/install/#how-do-i-set-tls-in-firefly-iii-or-the-data-importer).\n\n\n## It keeps giving me CSP errors {#it-keeps-giving-me-csp-errors}\n\n\nContent Security Policy headers are a security feature, and usually fail when you did not set `TRUSTED_PROXIES=*`.\n\n\n## All links refer to `http` so forms and charts don't work {#all-links-refer-to-http-so-forms-and-charts-dont-work}\n\n\nThis usually happens when you did not set `TRUSTED_PROXIES=*`.\n\n\n## For some reason one of the database migrations didn't \"take\" and now it's broken {#for-some-reason-one-of-the-database-migrations-didnt-take-and-now-its-broken}\n\n\nSometimes, Firefly III thinks all database tables are in place, but they're actually not. \n\nFrom Firefly III v6.4.19 and onwards, you can use the following command to remove the latest migration entry. This does not change your database.\n\n```\ndocker exec -it [container] php artisan correction:rollback-single-migration\n```\n\nThen, you can run:\n\n\n```\ndocker exec -it [container] php artisan migrate\n```\n\nIf it doesn't work, run the first command three or four times to remove more migrations.\n\n\n## Which other settings are available for the Docker image? {#which-other-settings-are-available-for-the-docker-image}\n\n\nThere are many environment variables that you can set in Firefly III. Just check out the [default env file](https://raw.githubusercontent.com/firefly-iii/firefly-iii/main/.env.example) that lists them all.\n\n\n## Allowed memory size of xxx bytes exhausted? {#allowed-memory-size-of-xxx-bytes-exhausted}\n\n\nStart the container with `PHP_MEMORY_LIMIT=512M` or more.\n\n\n## Can I run it under a reverse proxy from a subdirectory? {#can-i-run-it-under-a-reverse-proxy-from-a-subdirectory}\n\n\nYes. For the standard Docker image, follow [these instructions on GitHub](https://github.com/firefly-iii/firefly-iii/discussions/4892)\n\n> Installed a standalone Apache server, to act as an TLS-terminator.\n\n```\n<IfModule mod_ssl.c>\n<VirtualHost *:443>\n        ServerAdmin webmaster@localhost\n        DocumentRoot /var/www/html\n\n        ErrorLog ${APACHE_LOG_DIR}/error.log\n        CustomLog ${APACHE_LOG_DIR}/access.log combined\n\n        ServerName ...\n        SSLCertificateFile /etc/letsencrypt/live/.../fullchain.pem\n        SSLCertificateKeyFile /etc/letsencrypt/live/.../privkey.pem\n        Include /etc/letsencrypt/options-ssl-apache.conf\n\n        <Location /accounts>\n            ProxyAddHeaders Off\n            RequestHeader unset Accept-Encoding\n            ProxyPass http://localhost:8087\n            ProxyPassReverse http://localhost:8087\n            AddOutputFilterByType SUBSTITUTE text/html\n            Substitute \"s|http://localhost:8087/|https://.../accounts/|i\"\n        </Location>\n</VirtualHost>\n</IfModule>\n```\n\n> `ProxyAddHeaders` is off to prevent Apache sending the X-Forward headers to Firefly III, otherwise the URLs it populates in the response will include the correct website, but not the correct path.\n\n> Unsetting the `Accept-Encoding` header ensures that the response from Firefly III is not compressed, otherwise the `Substitute` directive won't work.\n\n> `ProxyPass` and `ProxyPassReverse` act as you would expect, so that Firefly III will appear under the \"accounts\" directory.\n\n> The `AddOutputFilterByType` and `Substitute` directives alter the pages returned from Firefly III, replacing the localhost URLs with the website's URL. Replace \"...\" with your website address.\n\nThanks to [@cartbar](https://github.com/cartbar)!\n\n\n## I get 'permission denied' errors on the cache folder {#i-get-permission-denied-errors-on-the-cache-folder}\n\n\nThis is caused by a permissions issue. Run the following command:\n\n* `docker exec -it <container> php artisan cache:clear`\n\nOr browse to the `/flush` page in your installation.\n\n\n## I see a lot of log entries from the \"Firefly III Health Checker\" {#i-see-a-lot-of-log-entries-from-the-firefly-iii-health-checker}\n\n\nThis is normal. The health checker is called by Docker to see if Firefly III is still up and running.\n\n\n## I get \"Function not implemented: AH00141: Could not initialize random number generator\" {#i-get-function-not-implemented-ah00141-could-not-initialize-random-number-generator}\n\n\nThis is an error that happens on Synology boxes with an old kernel. I'm sorry, there is nothing I can do for you.\n\n\n## The database password is wrong, but I'm 100% sure it's correct {#the-database-password-is-wrong-but-im-100-sure-its-correct}\n\n\nIf you start the database container with a `MYSQL_PASSWORD` that you change later, it won't change in the database. Destroy the volume + container and start over. This also happens when you start Firefly III for the first time, \"to see if it works\", and then decide to configure a more secure password.\n\nIf this happens to you there is no easy way to fix this unless you happen to have saved the random root password that the database generated when it first started, and nobody does that. \n\nWhat you must do to fix this:\n\n- Stop and remove all Firefly III containers: database, cron, Firefly III, the Data Importer\n- Remove all related volumes: upload, db and perhaps others.\n- Restart the Docker Compose file or restart your container(s).\n\nThis should regenerate everything, and use the correct passwords.\n\n\n## I get 'failed to open stream: Permission denied' on log files {#i-get-failed-to-open-stream-permission-denied-on-log-files}\n\n\nThis is caused by a permissions issue. Often, this is caused by cron jobs running under root, not `www-data`.\n\nAll your Docker commands must run as `www-data`, also in cron jobs:\n\n* `docker exec [container] --user www-data /usr/local/bin/php /var/www/html/artisan firefly-iii:cron`\n\n\n## How do I debug a cron job on Docker? {#how-do-i-debug-a-cron-job-on-docker}\n\n\nEnable [debug mode](/how-to/general/debug/). Open a new terminal window, and tail the logs from your Firefly III docker container:\n\n```bash\ndocker logs -f CONTAINERID\n```\n\nFire the cron job again from another terminal window, with the following command.\n\n```bash\ndocker exec --user www-data CONTAINERID /usr/local/bin/php /var/www/html/artisan firefly-iii:cron --date=2021-02-01\n```\n\nIn the command you see a date. Change it to be the first day of the *current* month in the format `YYYY-MM-DD`.\n\n\n## Something about Authentik? {#something-about-authentik}\n\n\nSet the environment variable as follows:\n\n```\nAUTHENTICATION_GUARD_HEADER=HTTP_X_AUTHENTIK_EMAIL\n```\n\nFor more info, see [issue #7460](https://github.com/firefly-iii/firefly-iii/issues/7460) on GitHub.\n",
      "documentId": "references/faq/docker",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/references/faq/docker/",
          "markdown": "https://sourcey-firefly.pages.dev/references/faq/docker/index.md"
        }
      ]
    },
    {
      "id": "explanation/support/index.md",
      "kind": "page",
      "title": "Support",
      "description": "If you found a bug, have a feature request or another idea for improvements, please open an issue on GitHub.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/support/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/support/index.md",
      "file": "explanation/support/index.md",
      "searchText": "\n# Support {#support}\n\n\n<!-- HELP TEXT -->\n\nDo you want to contact me? You can email me at [james@firefly-iii.org](mailto:james@firefly-iii.org) or get in touch through one of the following support channels:\n\n- [GitHub Discussions](https://github.com/firefly-iii/firefly-iii/discussions/) for questions and support\n- [Gitter.im](https://gitter.im/firefly-iii/firefly-iii) for a good chat and a quick answer\n- [GitHub Issues](https://github.com/firefly-iii/firefly-iii/issues) for bugs and issues\n- <a rel=\"me\" href=\"https://fosstodon.org/@ff3\">Mastodon</a> for news and updates\n\n<!-- END OF HELP TEXT -->\n\n\n## Issues {#issues}\n\n\nIf you found a bug, have a feature request or another idea for improvements, please open an issue on **[GitHub](https://github.com/firefly-iii/firefly-iii/issues)**.\n\n\n## Roadmap {#roadmap}\n\n\nCheck out **[the roadmap](https://roadmap.firefly-iii.org/)** to see the future of Firefly III and the associated tools.\n\n\n## Who maintains Firefly III and why? {#who-maintains-firefly-iii-and-why}\n\n\nFirefly III is built and maintained by James Cole, a software developer from the Netherlands. He started developing Firefly III back in 2012, to manage his own finances.  \n\nYou can contact him through email on [james@firefly-iii.org](mailto:james@firefly-iii.org). His PGP key is mentioned on [Keybase.io](https://keybase.io/jc5). The fingerprint is `02F4 046C 4B23 6E06 0957 1612 B49A 324B 7EAD 6D80`. You can [verify that key](https://gist.github.com/JC5/e5810692bea4513bd80381f57b2ed03a).\n\n\n## Security considerations {#security-considerations}\n\n\n\n\n> [!CAUTION]\n> If you find a security issue or problem with Firefly III, please refer to the [Security Policy](https://github.com/firefly-iii/firefly-iii/security/policy).\n\n\n\n<!-- SPONSOR TEXT -->\n\n\n## Support the development of Firefly III {#support-the-development-of-firefly-iii}\n\n\nFirefly III is a side gig. With your sponsorship or support, I can spend more time on Firefly III. So, if you like Firefly III, and if it helps you save lots of money, why not send me a dime for every dollar saved! 🥳\n\nOK, that was a joke. But for real, when you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my [Patreon](https://www.patreon.com/jc5) and [GitHub Sponsors](https://github.com/sponsors/JC5) page for more information. You can also [buy me a ☕️ coffee at ko-fi.com](https://ko-fi.com/Q5Q5R4SH1) or send something my way using [Liberapay](https://liberapay.com/JC5). Thank you for your consideration.\n\n\n### Sponsorships {#sponsorships}\n\n\nFirefly III is sponsored by TestMu AI. Their support allows me to test Firefly III more easily and introduce even fewer bugs with every release.\n\nBrowser testing via TestMu AI:\n\n<a href=\"https://www.testmuai.com/?utm_source=fireflyiii&utm_medium=sponsor\" target=\"_blank\">\n<img src=\"/_media/59e406ce9676e24c2e22.png\" alt=\"TestMu AI\" style=\"vertical-align: middle;\" width=\"250\" />\n</a>\n\n<!-- END OF SPONSOR TEXT -->\n\n\n## Contributing code text and documentation to Firefly III {#contributing-code-text-and-documentation-to-firefly-iii}\n\n\nThe text of the [contribution guidelines can be found on a dedicated page](/explanation/contributing/).\n\n\n### Rules {#rules}\n\n\n- Read [Google's guidelines for inclusive documentation](https://developers.google.com/style/inclusive-documentation).\n- It's \"Firefly III\". Nothing else will be accepted.\n- Do not use terminology like \"just\", \"simple\", \"easy\", or \"all you have to do\".\n- Be informal and encouraging.\n- Never be angry in your tone of voice when writing.\n\n\n## Credits {#credits}\n\n\nFirefly III uses the following libraries and tools:\n\n* The AdminLTE template by [Almsaseed Studio](https://almsaeedstudio.com/)\n* [Chart.js](http://www.chartjs.org/)\n* [Bootstrap](http://getbootstrap.com/)\n* [Laravel](http://laravel.com/)\n* [Twig](http://twig.sensiolabs.org/)\n* For development, some excellent tools made by [Barry van den Heuvel](https://github.com/barryvdh)\n* [Bootstrap sortable](https://github.com/drvic10k/bootstrap-sortable). by [Matúš Brliť](https://github.com/drvic10k)\n* [Date range picker](https://github.com/dangrossman/bootstrap-daterangepicker/) by [Dan Grossman](https://github.com/dangrossman)\n* The [real favicon generator](http://realfavicongenerator.net/)\n* The favicon has been made by [Smashicons](https://www.flaticon.com/authors/smashicons).\n* Alternative icon has been made by [Freepik](http://www.freepik.com).\n* The cute piggy is by [Fabian Blank](https://unsplash.com/collections/388522/money-revenue).\n* Various other open source components (see [composer.json](https://github.com/firefly-iii/firefly-iii/blob/main/composer.json))\n* CSV file icon made by [Smashicons](https://www.flaticon.com/authors/smashicons).\n\n\n## License {#license}\n\n\nFirefly III is licensed under the [GNU Affero General Public License v3.0](https://github.com/firefly-iii/firefly-iii/blob/main/LICENSE) (or later). [Read more about this](/explanation/more-information/license/).\n",
      "documentId": "explanation/support",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/support/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/support/index.md"
        }
      ]
    },
    {
      "id": "explanation/index.md",
      "kind": "page",
      "title": "Explanation",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/index.md",
      "file": "explanation/index.md",
      "searchText": "\n# Explanation {#explanation}\n\n\nIf 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.\n\nPopular pages include:\n\n1. Financial concepts such as [transactions](/explanation/financial-concepts/transactions/) and [liabilities](/explanation/financial-concepts/liabilities/)\n2. [Security](/explanation/more-information/security/)\n3. [Zero based budgeting](/explanation/firefly-iii/background/zero-based-budgeting/)\n\n\n## Missing something? {#missing-something}\n\n\n1. You're missing specific explanations or information, and you wish to write it\n2. You don't want to write it, but you still miss specific information\n3. You spot inaccuracies, terrible grammar or spelling mistakes\n\nPlease open an [issue on GitHub](https://github.com/firefly-iii/firefly-iii/issues/new?assignees=&labels=&projects=&template=fr.yml). Your contributions are appreciated.\n\n\n## Would you like to know more? {#would-you-like-to-know-more}\n\n\nCheck out the [support page](/explanation/support/).\n",
      "documentId": "explanation",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/index.md"
        }
      ]
    },
    {
      "id": "explanation/data-classification/best-practices/index.md",
      "kind": "page",
      "title": "Best practices",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/data-classification/best-practices/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/data-classification/best-practices/index.md",
      "file": "explanation/data-classification/best-practices/index.md",
      "searchText": "\n# Best practices {#best-practices}\n\n\nDepending on what financial application you're used to organizing your data with, you will find that Firefly III can be a little bit different.\n\nThis page tries to explain the most common use cases in transaction and financial management in Firefly III, and how to use the financial concepts Firefly III has. \n\nSee also the page [organizing transactions](/explanation/data-classification/what-to-use/) which tells you what each field in a transaction can be used for.\n\n\n## Transaction management {#transaction-management}\n\n\nA transaction is a single withdrawal or income or transfer between two accounts. Contrary to systems like GNUcash the opposing account is as simple as the name of a store or one or your asset accounts. \n\nThe description, source account, amount and destination account should tell you what the transaction is about, i.e. \"14,95 EUR from Main Asset Account to Albert Heijn.\"\n\nExtra information can be stored in the budget, category and tag fields of the transaction. You can also add notes, but they are only visible when you view the transaction itself. \n\nTry to be descriptive, give transactions at least a budget so you have the grand scheme of things recorded. \n\n\n## How do I know how much I saved? {#how-do-i-know-how-much-i-saved}\n\n\nFirefly III does not have \"buckets\" like zero-based budgeting does. As a rule, the money in your asset or savings accounts is not \"divided\" like that. However, you can create piggy banks which is actually the \"buckets\" you might be looking for. \n\nCreate a piggy bank for a specific target or goal, with or without an upper limit and connect it to your savings account. Any new money then sent to your savings account is then ready to be divided over these piggy banks.\n\nMoney in piggy banks is not subtracted from your total balance, or blocked from spending or anything like that. If you divide your money over piggy banks you won't see a balance of zero, for example. \n\n\n## How do I know how much I can spend? {#how-do-i-know-how-much-i-can-spend}\n\n\nUse budgets. Make sure the amount of money on your bank account is the same as you have budgeted. If you budget for a total of € 2000,-, start the month with that amount in your account. Or if not, budgets are the way to track your expenses.\n",
      "documentId": "explanation/data-classification/best-practices",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/data-classification/best-practices/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/data-classification/best-practices/index.md"
        }
      ]
    },
    {
      "id": "explanation/data-classification/what-to-use/index.md",
      "kind": "page",
      "title": "Data classification",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/data-classification/what-to-use/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/data-classification/what-to-use/index.md",
      "file": "explanation/data-classification/what-to-use/index.md",
      "searchText": "\n# Data classification {#data-classification}\n\n\nIn 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.\n\n\n## Accounts {#accounts}\n\n\nYou should have one asset [account](/explanation/financial-concepts/accounts/) per actual account that you have. If your bank supports sub-accounts, you can also make asset accounts for those.\n\nPersonally, I make separate *expense accounts* for each store and merchant I buy stuff from. So, bol.com, Albert Heijn, Zalando, are all separate expense accounts. The same applies to *revenue accounts*.\n\nOptionally, you can lump all these expenses together under one expense account called \"Daily shopping expenses\", it's up to you.\n\nI do the same thing for revenue accounts, to track where my money is coming from: \"JobGiver Inc.\", \"GitHub\", and friends that pay me back are all separate revenue accounts. \n\nOne personal exception: I lump together all payments from payment request services. Famous ones include \"Tikkie\" and \"Venmo\". I organized a goodbye party for a colleague from work and I didn't really feel like creating or managing dozens of one-time revenue accounts. So now I just have one revenue account called \"Tikkie\".\n\n\n## Budgets {#budgets}\n\n\nBudgets are the only option you have that allows you to set an upper limit on your spending. So, track money in broad strokes using budgets: groceries, cost-of-living (rent etc), going out, car.\n\nTracking smaller things is possible (personal hygiene expenses, gardening tools) but does mean you have to budget for all these types of expenses.\n\nIntermittent expenses (less than twice a month) are not really suited to be tracked in a budget. Use a catch-all budget like groceries or something encompassing like \"everything else.\"\n\n\n## Categories {#categories}\n\n\nUse categories to be more specific in the organization of your expenses. Within the scope of your budget if necessary. \"Daily groceries\", \"personal hygiene\" or \"vegetables\" are categories that are fine, and can be combined with a budget like \"daily groceries.\"\n\nYou can't force a subset of categories for specific budgets though.\n\n\n## Tags {#tags}\n\n\nUse tags to be judgy about your expenses. I have a tag `bad buy 2026`, and similar tags for previous years. As you can imagine, I track my bad buys using this tag. It's also possible to use the [product manager](https://github.com/JC5/product-manager/) or similar tools to organize your data in tags.\n\n\n## Object groups {#object-groups}\n\n\nObject groups are a option for piggy banks and bills, and not used elsewhere. Use them to group things together.\n",
      "documentId": "explanation/data-classification/what-to-use",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/data-classification/what-to-use/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/data-classification/what-to-use/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/administrations/index.md",
      "kind": "page",
      "title": "Financial administrations",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/administrations/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/administrations/index.md",
      "file": "explanation/financial-concepts/administrations/index.md",
      "searchText": "\n# Financial administrations {#financial-administrations}\n\n\nFirefly 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.\n\nNaturally, this means that you can share a financial administration, so two or more people work on the same set of records. This is not yet finished work, I'm still building this.\n\n\n## Administration settings {#administration-settings}\n\n\nFor now, under the \"Financial administrations\" entry in the left hand menu (or `/administrations`), you can set the primary currency for your administration. This is the currency that all your accounts and transactions will be in by default. You can also create transactions in any other currency, but this will be the default.\n\nThis setting, for those of you who are familiar with it, replaces the \"default currency\"  setting that was places under [Currencies](/explanation/financial-concepts/currencies/) (`/currencies`).\n\nOnce this feature is finished, more information will be added to this page.\n",
      "documentId": "explanation/financial-concepts/administrations",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/administrations/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/administrations/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/transactions/index.md",
      "kind": "page",
      "title": "Transactions",
      "description": "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 records are straight.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/transactions/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/transactions/index.md",
      "file": "explanation/financial-concepts/transactions/index.md",
      "searchText": "\n# Transactions {#transactions}\n\n\nSee also: \n\n- [Tutorial: Create accounts and transactions](/tutorials/finances/first-steps/)\n- [How to organize transactions](/how-to/firefly-iii/finances/transactions/)\n- [A reference to all transaction types](/references/firefly-iii/transaction-types/)\n\n\n## What is a transaction in Firefly III? {#what-is-a-transaction-in-firefly-iii}\n\n\nMoney moves from A to B. It doesn't matter if this is an expense, your salary or you moving money around: _money moves from A to B_:\n\n![Transferring money from your checking account to your savings account](/_media/ba04e1cfbebfc61e73a8.png)\n\n![An expense is moving money from you to the supermarket.](/_media/a6f180bd8105c3377251.png)\n\nIn Firefly III and most other systems this is stored using a \"[double-entry bookkeeping system](http://en.wikipedia.org/wiki/Double-entry_bookkeeping_system)\". You get money and your boss loses it. You spend money and the Supermarket \"earns\" it:\n\n![Your boss loses money, you earn it.](/_media/f648d3230d57ca5c2b94.png)\n\n![You lose money, the supermarket earns it.](/_media/3c6c1eacb22246bfd39e.png)\n\nEach 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 records are straight.\n\nIt is also useful when transferring money back and forth between your own accounts. This is the same as spending money. It's all moving money around. This helps maintain the internal consistency of the database.\n\n\n## What are split transactions? {#what-are-split-transactions}\n\n\nWhat has been described here are \"singular transactions\". Firefly III stores each financial transaction in a journal. Each journal contains two \"transactions\". One takes money (-250 from your bank account) and the other one puts it into another account (+250 for Amazon.com).\n\nYou can verify this by counting. There are always twice as many \"transactions\" as there are \"journals\" in your database.\n\nThis way, Firefly III tries to stay true to what a financial transaction is, which is kind of singular. Money moves from A to B, end of story. Nothing more.\n\nHowever, often an expense tells a story. Take grocery receipts for example. It's one expense sure, but it consists of many parts. And when you buy aspirin and bread at the same time, you might want to split the expense over two budgets, medication and groceries. A single expense would make you lose information.\n\nLikewise, your salary may have multiple components. Your base salary may be 1200. Plus 100 bonus. Etc. All that information is lost when you enter it using a singular, not split deposit.\n\n![Transaction with multiple parts](/_media/757653b2fe96f7d7c321.png)\n\nAny time you create a deposit, transfer or a withdrawal, Firefly III lets you **split** a transaction into multiple parts. When you do this, you can:\n\n* Assign part of an expense to a budget;\n* Assign different revenue accounts to parts of a deposit.\n* Categorize money differently.\n\nYou can split your entire groceries-receipt into small \"sub\"-transactions. Or you can specify each component of your salary.\n\n\n### Constraints {#constraints}\n\n\nIt's important to realise the following constraints when dealing with split transactions.\n\n* When making an expense (withdrawal), you can only split the destination accounts, not the source accounts. You can't create one expense that originates from two or three asset accounts. But you can divide a withdrawal over several expense accounts. You can split your groceries over several departments, but you can't pay a bill from two asset accounts.\n* Deposits must end up in one asset account. You can't make a deposit from one revenue accounts and split it over separate asset accounts. Your salary, when divided over different splits, must end up in one asset account.\n* Transfers can be split, but all splits must have the same source + destination.\n",
      "documentId": "explanation/financial-concepts/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/transactions/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/transactions/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/accounts/index.md",
      "kind": "page",
      "title": "Accounts",
      "description": "And many more subjects under the how-to and tutorial sections.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/accounts/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/accounts/index.md",
      "file": "explanation/financial-concepts/accounts/index.md",
      "searchText": "\n# Accounts {#accounts}\n\n\nSee also:\n\n- [Reference: all account types](/references/firefly-iii/account-types/)\n- [How-to: reconcile accounts](/how-to/firefly-iii/finances/reconcile/)\n- [Tutorial: my first accounts](/tutorials/finances/first-accounts/)\n\nAnd many more subjects under the [how-to](/how-to/) and [tutorial](/tutorials/) sections.\n\nFirefly III has several types of accounts. This goes beyond your own bank accounts and credit cards. Accounts are one of the core concepts of Firefly III. In a double booking system, everything is related to an account. Accounts are the holders of transactions and each transaction in Firefly III must have a source and a destination account.\n\n\n## Unique account numbers and IBANs {#unique-account-numbers-and-ibans}\n\n\nFirefly III will not let you create multiple accounts with the same IBAN or account number. They have to be unique.\n\nOne exception exists for expense accounts and revenue accounts. As you have read, expense and revenue accounts are used as the opposing accounts for your transactions. But you may run into the situation where you have an expense account with the same name as a revenue account. For example, \"Government Tax Department\" which both *pays* you money and *gives* you money (but probably a lot less often).\n\nSuch accounts can share an IBAN or an account number. They don't need to have the same name.\n\nAsset accounts can't use an IBAN or an account number if it's taken by either an expense account a revenue account.\n\n\n## A note on your opening balance {#a-note-on-your-opening-balance}\n\n\nWhen you define an account's opening balance, you also have to set the date. Keep in mind that the opening balance is a transaction too. Let's say you set your opening balance to be 270- on December 1st. Trick question. What was your balance the week before, in November 27th? And assume no other transactions have been made.\n\nThe correct answer is: 0.00. Because the opening balance was posted one week later, the balance of the account _before_ the opening balance is zero.\n\nSo if you set an opening balance for an account and create transactions from before the opening balance, the running balance may not be what you expect.\n\n\n## Virtual balance {#virtual-balance}\n\n\nIf you set a virtual balance, that amount will always be added to the actual balance of the account. If your credit card limit is 1000, set a virtual balance of 1000.\n",
      "documentId": "explanation/financial-concepts/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/accounts/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/accounts/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/budgets/index.md",
      "kind": "page",
      "title": "Budgets",
      "description": "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 budget.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/budgets/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/budgets/index.md",
      "file": "explanation/financial-concepts/budgets/index.md",
      "searchText": "\n# Budgets {#budgets}\n\n\n\n## Introduction {#introduction}\n\n\nFirst of all, if you want to do specific things with budgets, check out:\n\n- [How-to manage budgets](/how-to/firefly-iii/finances/budgets/)\n- [How-to configure cron jobs](/how-to/firefly-iii/advanced/cron/)\n\nBudgets 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 budget.\n\nSo, in Firefly III, you will get used to seeing budgets in the context of their name and the amount (left):\n\n1. Groceries, 300 per month\n2. Bills, 1200 per year\n\n\n## Budget ranges {#budget-ranges}\n\n\nFirefly III supports the following budget ranges:\n\n - Daily\n - Weekly\n - Monthly\n - Quarterly\n - Every half year\n - Yearly\n\nFirefly III does not support bi-weekly budgets. You will have to set weekly budget divided by two.\n\n\n## Budget amounts {#budget-amounts}\n\n\nA budget can be set an amount. This amount needs to be set every period (see earlier). Firefly III can set these amounts automatically. You can also make these amounts overlap, setting BOTH a yearly amount and a monthly amount. This is tricky though because withdrawals will be subtracted from BOTH amounts when you do this.\n\nA transaction with a budget influences the period's amount for a budget. In other words, when you set an amount of 100 for budget \"Groceries\" for the period 1-8 July, any transaction in that particular date range will lower that amount. At some point, your budget will be depleted.\n\nYou can still select the budget for transactions, and Firefly III will not complain, but you should keep track of these amounts and make sure you don't go over budget.\n\n\n## Budgets and foreign currencies {#budgets-and-foreign-currencies}\n\n\nBudgeting can get complex when you use multiple budgets, and multiple currencies. As a rule, budgets will only count the main currency of a transaction, and *never* the \"foreign\" amount of a transaction. That means a few things.\n\n- A budget with the amount set to EUR 100 will not be influenced by transactions in USD, even when those transactions are linked to the budget. To do so, you must set a second amount for the same budget in USD, and those transactions will be counted towards that particular amount.\n- A budget with the amount set to USD 100 will **not** be influenced by a transaction with a *foreign amount* in USD.\n\nIn short, only the main amount of a transaction will influence the budget. The foreign amount is not used for budgeting.\n\n\n## Budgets and displaying amounts in your primary currency {#budgets-and-displaying-amounts-in-your-primary-currency}\n\n\nEven when you convert all your amounts to your primary currency, the behavior of budgets does not change. \n\n\n## Budgets and income {#budgets-and-income}\n\n\nYou cannot assign income to a budget to automatically increase the budgets amount. If you have more money available for the budget, you must increase the budget manually.\n\n\n## The difference with categories {#the-difference-with-categories}\n\n\nThe difference with categories is that budgets are used to budget your expenses, and can be used to monitor your spending around a specific subject. Most people use categories to add more fine-grained details to a transaction, but categories cannot be \"monetized\".\n",
      "documentId": "explanation/financial-concepts/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/budgets/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/budgets/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/liabilities/index.md",
      "kind": "page",
      "title": "Liabilities",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/liabilities/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/liabilities/index.md",
      "file": "explanation/financial-concepts/liabilities/index.md",
      "searchText": "\n# Liabilities {#liabilities}\n\n\nA liability is a debt: either money you owe or money that is owed to you. In Firefly III you can track both of these.\n\nTo learn more about liabilities, check out these pages:\n\n- [Tutorial: manage your mortgage](/tutorials/finances/mortgage/)\n- [How-to manage liabilities](/how-to/firefly-iii/finances/liabilities/)\n\n\n## You owe money {#you-owe-money}\n\n\nThe general idea of a liability where you owe money (let's call it a debt) is that there is a account with a negative amount in Firefly III\nthat represents the debt. Once you fill this particular hole, the money is yours again.\n\nThere is a difference here whether the money is usable by you or not. For example, if you borrowed money, and it was spent on a house (aka a mortgage), the \nmoney is \"nowhere\", and not part of your finances. In other cases, you can transfer money from the debt to your asset account and then spend it.\n\nIn both cases the account balance is negative. Sending money to the liability is a \"withdrawal\", because it withdraws money from your accounts. If you get\nmoney from the loan to spend, it's a deposit.\n\n\n## You're owed money {#youre-owed-money}\n\n\nThis works almost exactly the same. There's a few differences though. A friend has borrowed 500, and is slowly paying you back.\n\nThe liability starts at 500. Every time your friend pays you back, you transfer money from the liability to your checking account. You'll notice \nthat this is a \"deposit\", and that the \"amount due\" goes down. Likewise, if you borrow them (more) money, the amount due goes up.\n",
      "documentId": "explanation/financial-concepts/liabilities",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/liabilities/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/liabilities/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/currencies/index.md",
      "kind": "page",
      "title": "Currencies",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/currencies/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/currencies/index.md",
      "file": "explanation/financial-concepts/currencies/index.md",
      "searchText": "\n# Currencies {#currencies}\n\n\nTo learn more about currencies, check out:\n\n- [How-to: manage your currencies](/how-to/firefly-iii/features/currencies/)\n\nFirefly 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](https://en.wikipedia.org/wiki/ISO_4217).\n\nFirefly III supports at most 8 decimals for currencies. This is due to system limits on most systems when it comes to math. In practice, this may mean you will not be able to add cryptocurrencies. \n",
      "documentId": "explanation/financial-concepts/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/currencies/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/currencies/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/piggy-banks/index.md",
      "kind": "page",
      "title": "Piggy banks",
      "description": "To learn how to manage piggy banks, please read how to manage piggy banks.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/piggy-banks/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/piggy-banks/index.md",
      "file": "explanation/financial-concepts/piggy-banks/index.md",
      "searchText": "\n# Piggy banks {#piggy-banks}\n\n\nTo learn how to manage piggy banks, please read [how to manage piggy banks](/how-to/firefly-iii/finances/piggy-banks/).\n\n\n## What is a piggy bank in Firefly III? {#what-is-a-piggy-bank-in-firefly-iii}\n\n\nIf you want to buy something expensive, you might need to save for it. You can use \"piggy banks\" to organize your savings. A piggy bank is a way to divide your money in a number of parts. A piggy bank is meant to group money on a single asset account together.\n\n\n## Where are piggy banks stored? {#where-are-piggy-banks-stored}\n\n\nPiggy banks are stored under the `/piggy-banks`-page in Firefly III. Each piggy bank is tied to an asset account on which its money is saved. You may have a savings account with three piggy banks, for example.\n\n\n## And then what? {#and-then-what}\n\n\nThe money in your savings account can be added and removed to piggy banks freely. You can also transfer money in and out of your savings account and select a piggy bank to be associated with the transfer. The money will be added to (or removed from) the piggy bank as part of the transfer.\n\nYou can't create a withdrawal or a deposit and refer to a piggy bank. It only works for transfers.\n\nAdding money to piggy banks, or removing money from them, will not influence their balance. If you want to see how much money is left for piggy banks, see the bottom of the `/piggy-banks`-page.\n",
      "documentId": "explanation/financial-concepts/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/piggy-banks/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/piggy-banks/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/subscriptions/index.md",
      "kind": "page",
      "title": "Subscriptions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/subscriptions/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/subscriptions/index.md",
      "file": "explanation/financial-concepts/subscriptions/index.md",
      "searchText": "\n# Subscriptions {#subscriptions}\n\n\nIf you want to learn about subscriptions please also check out:\n\n- [Tutorial: How to manage a subscription](/tutorials/finances/subscription/)\n- [How to: manage your subscriptions](/how-to/firefly-iii/finances/subscriptions/)\n\nYou 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.\n\nThe idea of a subscription is that it represents a recurring *subscription* that comes back every week, month or year. Subscriptions don't automatically update your budgets, they aren't linked to those. You have to do that yourself. \n\nEssentially a subscription is just a collection of withdrawals. You can't link income or transfers to subscriptions, only withdrawals. So, you can't use subscriptions to keep track of your salary or your savings account.\n\nSubscriptions also have some properties like a basic repetition (every week, every 3 months) and a minimum and maximum amount. These properties are used to predict how much you should expect to spend on these subscriptions. On the frontpage, a little box will tell you how you're doing. It's possible to connect a subscription to a withdrawal more often than your repetition would predict. It's also possible to link transactions with more or less money than your minimum and maximum amounts. \n\n\n## What is the difference between a subscription and a recurring transaction? {#what-is-the-difference-between-a-subscription-and-a-recurring-transaction}\n\n\nMost users use recurring transactions when they do not import data into Firefly III. Because then, it may be useful to have Firefly III create transactions automatically.\n\nIf you import data using (for example) CSV files, this is not necessary. You can just import the data and link it to a subscription.\n\nPersonally, I link recurring transactions to subscriptions. You can see the option for it when you create a recurring transaction.",
      "documentId": "explanation/financial-concepts/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/subscriptions/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/subscriptions/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/recurring/index.md",
      "kind": "page",
      "title": "Recurring transactions",
      "description": "Firefly III features the ability to automatically create transactions, so you don't have to. These are called recurring transactions.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/recurring/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/recurring/index.md",
      "file": "explanation/financial-concepts/recurring/index.md",
      "searchText": "\n# Recurring transactions {#recurring-transactions}\n\n\nSee also:\n\n- [How to use recurring transactions](/how-to/firefly-iii/finances/recurring/)\n\nFirefly III features the ability to automatically create transactions, so you don't have to. These are called recurring transactions.\n\nA recurring transaction can be a withdrawal, deposit or a transfer.\n\n\n## So what is the difference between a subscription and a recurring transaction? {#so-what-is-the-difference-between-a-subscription-and-a-recurring-transaction}\n\n\nMost users use recurring transactions when they do not import data into Firefly III. Because then, it may be useful to have Firefly III create transactions automatically.\n\nIf you import data using (for example) CSV files, this is not necessary. You can just import the data and link it to a subscription.\n\nPersonally, I link recurring transactions to subscriptions. You can see the option for it when you create a recurring transaction.",
      "documentId": "explanation/financial-concepts/recurring",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/recurring/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/recurring/index.md"
        }
      ]
    },
    {
      "id": "explanation/financial-concepts/exchange-rates/index.md",
      "kind": "page",
      "title": "Exchange rate",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/exchange-rates/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/exchange-rates/index.md",
      "file": "explanation/financial-concepts/exchange-rates/index.md",
      "searchText": "\n# Exchange rate {#exchange-rate}\n\n\nFirefly 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. \n\n\n\n> [!WARNING]\n> Firefly III can only download the exchange rates of [the standard, built-in currencies](https://github.com/firefly-iii/firefly-iii/blob/main/database/seeders/TransactionCurrencySeeder.php#L38).\n\n\n\nThis is useful for some of the charts that Firefly III shows you. All monetary amounts will be calculated back to your base currency.\n\n\n## Configuration {#configuration}\n\n\nFirefly III supports three options that allow you to use exchange rates in the application. The following settings are disabled by default. You can change them on the `/settings/configuration`-page of your Firefy III installation.\n\n1. \"Enable exchange rates.\" This setting enables the feature in the first place. It will not be available otherwise.\n2. \"Download exchange rates from the web.\" Firefly III will not download exchange rates unless you allow it to. Exchange rates can only be downloaded for the default currencies in Firefly III. They will be downloaded from a Firefly III Azure bucket.\n3. In your preferences (`/preferences`) set the checkbox at \"Display amounts in your primary currency\".\n\n\n## Initialization {#initialization}\n\n\nIf you turn this on, transaction amounts will automatically be calculated in your primary currency whenever necessary. This happens when Firefly III boots. However, you may want to initialize this yourself if you want to. \n\nBy default, Firefly III ships with one or two sets of exchange rates for the built-in currencies. You can add new exchange rates yourself.\n\n\n## Recalculate amounts in your primary currency {#recalculate-amounts-in-your-primary-currency}\n\n\nUse the following command to recalculate all amounts. This may take some time if you have a lot of transactions in other currencies than your primary currency.\n\n```bash\n# self managed\nphp artisan correction:recalculate-pc-amounts\n\n# docker\ndocker exec -it [container-id] php artisan correction:recalculate-pc-amounts\n```\n\n\n## Changing your base (default) currency {#changing-your-base-default-currency}\n\n\nFirefly III only converts amounts back to your base (default) currency. You can set this currency on the `/administrations` page. Other conversions are not supported. For example, if your base currency is the Euro, you cannot see your British Pounds in US Dollars. The conversion will go back to the Euro only.\n\nIf you change your primary currency, all amounts will have to be recalculated. This may take some time if you have a lot of transactions in other currencies than your default currencies. \n\nYou can do this manually as well, using the command mentioned earlier.\n\n\n## Default exchange rate {#default-exchange-rate}\n\n\nIf Firefly III has no exchange rate data for either currency or when the conversion hasn't been calculated yet, the exchange rate is 1.\n\n\n## Changing the exchange rates {#changing-the-exchange-rates}\n\n\nIf you (significantly) change the exchange rates, you may want to recalculate the amounts to your primary currency again using the command mentioned earlier. This is not necessary, but it may be useful.\n\n\n## Conversion versus \"foreign amount\" {#conversion-versus-foreign-amount}\n\n\nFirefly III transactions also have a \"foreign amount\"-field. If you set a foreign amount in your primary currency, that amount will be used instead of any calculated amount. Firefly III assumes that you know better what the converted amount is. This is especially useful when you have a bank that has steep exchange rates.\n\n\n## Downloading exchange rates {#downloading-exchange-rates}\n\n\n\n\n> [!IMPORTANT]\n> This only works for the default system provided currencies because free exchange rate data is hard to come by.\n\n\n\nMake sure that you have enabled the settings at `/settings/configuration`, and run the [cron job](/how-to/firefly-iii/advanced/cron/) daily.\n\nFirefly III will download new rates about every week. You should see the list of available rates expand slowly. Firefly III will not download historical rates, ie. the rates for last year or last month.\n\n\n## Setting your own rates {#setting-your-own-rates}\n\n\nGo to the `/exchange-rates` and find your currency. You can set any rate you want to, in both directions.\n",
      "documentId": "explanation/financial-concepts/exchange-rates",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/exchange-rates/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/financial-concepts/exchange-rates/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/about/introduction/index.md",
      "kind": "page",
      "title": "Firefly III introduction",
      "description": "\"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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/introduction/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/introduction/index.md",
      "file": "explanation/firefly-iii/about/introduction/index.md",
      "searchText": "\n# Firefly III introduction {#firefly-iii-introduction}\n\n\n\"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.\n\nPersonal financial management is pretty difficult, and everybody has their own approach to it. Some people make budgets, other people limit their cash-flow by throwing away their credit cards, others try to *increase* their current cash-flow. There are tons of ways to save and earn money. Firefly III works on the principle that if you know where your money is going, you can stop it from going there.\n\nBy keeping track of your expenses and your income you can budget accordingly and save money. Stop living from paycheck to paycheck but give yourself the financial wiggle room you need.\n\n\n## Who is it for? {#who-is-it-for}\n\n\nThis application is for people who want to track their finances, keep an eye on their money **without having to upload their financial records to the cloud**. You're a bit tech-savvy, you like open source software, and you don't mind tinkering with (self-hosted) servers.\n\nPossibly, you're always short on money even though in theory, you make enough money to get by.\n\n\n## High-level overview {#high-level-overview}\n\n\nFirefly III can do the following things:\n\n- You can create and edit transactions, accounts, and give them budgets, categories and tags.\n- You can automate part of this with recurring transactions and auto-budgets.\n- You can keep track of liabilities.\n- You can **[import data](/how-to/)** into Firefly III from almost any bank.\n\n\n## Important details: {#important-details}\n\n\n- It is completely self-hosted and isolated, and will never contact external servers until you explicitly tell it to.\n- It features a REST JSON API that covers almost every part of Firefly III.\n- There are many translations available.\n- All pages feature help texts and support popups.\n\n\n## A list of features {#a-list-of-features}\n\n\n- Create recurring transactions to manage your money\n- Rule based transaction handling with the ability to create your own rules\n\nAlso interesting:\n\n* A double-entry bookkeeping system\n* You can store, edit and remove withdrawals, deposits and transfers. This allows you full financial management\n* You can manage different types of accounts\n    * Asset accounts\n    * Shared asset accounts (household accounts)\n    * Saving accounts\n    * Credit cards\n    * Liabilities (loans, mortgages)\n* It's possible to create, change and manage money using budgets\n* Organize transactions using categories\n* Save towards a goal using piggy banks\n* Predict and anticipate bills\n* View income and expense reports\n* Organize expenses using tags\n\nAnd the things you would hope for but not expect:\n\n* 2-factor authentication for extra security 🔒\n* Supports any currency you want\n* There is a Docker image available\n* Lots of help text in case you don't get it\n\nAnd to organise everything:\n\n* Clear views that should show you how you're doing\n* Easy navigation through your records\n* Browse back and forth to see previous months or even years\n* Lots of charts because we all love them\n* If you feel you’re missing something you can just ask me, and I'll add it!\n",
      "documentId": "explanation/firefly-iii/about/introduction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/introduction/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/introduction/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/about/screenshots/index.md",
      "kind": "page",
      "title": "Screenshots",
      "description": "Check it out yourself on the demo site.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/screenshots/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/screenshots/index.md",
      "file": "explanation/firefly-iii/about/screenshots/index.md",
      "searchText": "\n# Screenshots {#screenshots}\n\n\nCheck it out yourself on the [demo site](/explanation/firefly-iii/about/demo/).\n\n\n### The index of Firefly III {#the-index-of-firefly-iii}\n\n\n[![The index of Firefly III](/_media/54edc02ace862dafd901.png \"The index of Firefly III\")](/_media/20488a6cf3e6d1b7b563.png)\n\n\n### The account overview of Firefly III {#the-account-overview-of-firefly-iii}\n\n\n[![The account overview of Firefly III](/_media/566755096d5807c6f59b.png \"The account overview of Firefly III\")](/_media/0669ca4f7d95f64266e7.png)\n\n\n### Overview of all budgets {#overview-of-all-budgets}\n\n\n[![Overview of all budgets](/_media/30214f799b2206b10312.png \"Overview of all budgets\")](/_media/ac7a0901a6630ca90207.png)\n\n\n### A financial report in Firefly III {#a-financial-report-in-firefly-iii}\n\n\n[![A financial report in Firefly III](/_media/a6360d0150a6f99bf86b.png \"A financial report in Firefly III\")](/_media/85b6c697456545b4e1e5.png)\n\n",
      "documentId": "explanation/firefly-iii/about/screenshots",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/screenshots/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/screenshots/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/about/demo/index.md",
      "kind": "page",
      "title": "Demo website",
      "description": "Before you even install Firefly III, consider checking out the Firefly III demo website to get a feel for the product.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/demo/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/demo/index.md",
      "file": "explanation/firefly-iii/about/demo/index.md",
      "searchText": "\n# Demo website {#demo-website}\n\n\nBefore you even install Firefly III, consider checking out the **[Firefly III demo website](https://demo.firefly-iii.org/?mtm_campaign=documentation&mtm_kwd=demo-info)** to get a feel for the product.\n\nYou can log in with the username `demo@firefly` and password `demo`.\n\n\n## Public data importer {#public-data-importer}\n\n\nThe data importer is also available online. Read more on the page about the [public data importer](/references/data-importer/public/).\n",
      "documentId": "explanation/firefly-iii/about/demo",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/demo/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/about/demo/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/background/personal-finances/index.md",
      "kind": "page",
      "title": "Managing your personal finances",
      "description": "This is a description of how Firefly III works, and how I feel about personal finances.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/personal-finances/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/personal-finances/index.md",
      "file": "explanation/firefly-iii/background/personal-finances/index.md",
      "searchText": "\n# Managing your personal finances {#managing-your-personal-finances}\n\n\nThis is a description of how Firefly III works, and how I feel about personal finances.\n\nFirefly III has been built around how I manage my finances. Please read this carefully, so we match on how to do things.\n\n\n## The general idea {#the-general-idea}\n\n\nAfter being a grownup for a while I noticed I was living from paycheck to paycheck. I could not save money. At the end of my money, I still had a part of the month to cover.\n\nI built a system where you have transactions as the main concept of Firefly III. I've added an envelope-based based budgeting system. That means that you set a fixed amount every period (per month is most common). Firefly III can do that automatically as well.\n\nAs you spend money every month, the amount in the budget goes down (duh). Once the budget is empty, you will have to top it up or stop spending money on that particular subject. Most people have five or six budgets.\n\nThere are also categories and tags to further narrow down your transactions.\n\n\n## The next step {#the-next-step}\n\n\nTo keep on top of your finances (using Firefly III), you must be *aware* of your finances. There are no shortcuts. You can use the import function, and you can use the recurring transactions, but it won't help you one bit. It just gives you fancy charts. All knowledge and no wisdom.\n\nIf you're serious about changing your financial habits, you should enter each transaction manually. Feel the impact of each penny you spend, and before you know it you'll spend a lot less of them.\n\n\n## Accounting versus personal finance {#accounting-versus-personal-finance}\n\n\n\n\n> [!IMPORTANT]\n> The text below feels a bit like a rant, but I'm going to keep it up regardless.\n\n\n\nI don't like accounting. I don't like the fact that people buy a $60,000 sports car and then pretend they haven't just lost 60 grand by putting up the car as an \"asset\". As if you get your money back. I also don't like that people put up their house against their mortgage. It's not money. You don't have it. A Rembrandt could be worth a million, but it won't buy you a loaf of bread.\n\nSo, liability management in Firefly III isn't about your house versus your mortgage, it's just about your mortgage. \n",
      "documentId": "explanation/firefly-iii/background/personal-finances",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/personal-finances/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/personal-finances/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/background/zero-based-budgeting/index.md",
      "kind": "page",
      "title": "Zero based budgeting",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/zero-based-budgeting/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/zero-based-budgeting/index.md",
      "file": "explanation/firefly-iii/background/zero-based-budgeting/index.md",
      "searchText": "\n# Zero based budgeting {#zero-based-budgeting}\n\n\n\n\n> [!WARNING]\n> This page contains my personal opinion on personal finances. Feel free to disagree with me.\n\n\n\n[Zero based budgeting](https://en.wikipedia.org/wiki/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.\n\n\n## Paycheck to paycheck {#paycheck-to-paycheck}\n\n\nOne of the reasons I started Firefly III was because I was living paycheck to paycheck. To break the cycle, I started managing my finances from month to month instead of... from paycheck to paycheck.\n\nNow I decide for each *month* how much money I need to make it through that particular month. It could be an expensive month due to holidays or yearly bills, or it could be a (relatively) cheap month. Either way, I know this beforehand based on previous expenses and I set my monthly budgets accordingly.\n\nNaturally, I budget less money for these expected expenses than I make in total. The rest of the money is put away for the next month or for large expenses like that new tablet I had my eye on (see also \"[piggy banks](/explanation/financial-concepts/piggy-banks/)\"). This approach disconnects your finances from your paychecks and allows you to build a healthy way of saving and spending money.\n\nContrary, zero based budgeting keeps the focus on your paychecks and forces you to divide it over your budgets. Your primary driver becomes how much money you make and not how much money you spend. This is an important distinction.\n\n\n## How to manage this instead? {#how-to-manage-this-instead}\n\n\nI keep all my money on my savings account. My checking account only has the money I need to spend what I budgeted. On the 1st of the month, that account has exactly my budgets in them. At the end of the month it's (close to) zero. Salary I received in the meantime is stored on my savings account.\n\n\n## Long-term vs short-term goals {#long-term-vs-short-term-goals}\n\n\nIn real life, long-term saving goals and short term budgets are two different things. I have five budgets every month. Not 30 or 40. Just five: \"Bills\", \"groceries\", \"misc\", \"going out\" and \"work-related\". I need no other budgets, because I have no other expenses outside of these budgets.\n\nOf course, I can split \"misc\" into multiple budgets. I used to have a \"going out\"-budget, but that was before COVID-19. I should think about an \"online\"-budget because I spend money every month on games and apps.\n\nEither way, these are my short-term goals, the money I *need* every month to live. Any other expenses are incidental and don't need a budget. At most, a category to group them in. But no budget.\n\nFor each (future) large expense I have a piggy bank connected to my savings account. This includes large bills and gadgets I want to buy. My liabilities like my student debt are stored as [a liability](/explanation/financial-concepts/liabilities/) and the money I need to pay my debt, is part of my monthly bills.\n\n\n## Conclusion {#conclusion}\n\n\nI believe you should skip on zero-based budgeting tools. They are easier to learn and easier to use, it's absolutely true. Most zero-based budgeting tools (especially the commercial ones) are also way better looking and more user-friendly than Firefly III.\n\nBut also keep in mind: it's harder to spend less money with zero-based budgeting. It's harder to get a feeling for your financial situation with zero-based budgeting, and it's especially harder to *change* anything. And is that not why you started looking at these tools?\n\n\nUse Firefly III. Use GnuCash. Use anything from [this list](https://github.com/awesome-selfhosted/awesome-selfhosted#money-budgeting--management). But skip the zero-based nonsense. \n\n\n## I came over from YNAB, I don't get it? {#i-came-over-from-ynab-i-dont-get-it}\n\n\nYNAB and Firefly III have a slightly different way of working.\n\nYNAB kind of works the other way around, by budgeting the money that comes in instead of the money that goes out. They expect you to think of a budget for every coin tossed to you instead of budgeting what you expect to spend.\n\nYNAB expects you to put your money into budgets based on whatever money comes in. But that's not how Firefly III works. Firefly III works the other way around. At the start of the month, you decide what you want to spend. If everything is OK, your budget should at least match what you earn. So that's easy. But if everything is _better_ than OK, you budget **less** than you make, and you **save** the rest. You can use the rest of the money to fill piggy banks or donate to me (kidding ;)).\n",
      "documentId": "explanation/firefly-iii/background/zero-based-budgeting",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/zero-based-budgeting/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/zero-based-budgeting/index.md"
        }
      ]
    },
    {
      "id": "explanation/firefly-iii/background/time-periods/index.md",
      "kind": "page",
      "title": "Time periods",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/time-periods/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/time-periods/index.md",
      "file": "explanation/firefly-iii/background/time-periods/index.md",
      "searchText": "\n# Time periods {#time-periods}\n\n\nFirefly 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.\n\n\n## Custom daily cycles {#custom-daily-cycles}\n\n\nFirefly III does not (and will not) support custom cycles. For example, you will not be able to make Firefly III go from the 24th of one month to the 23rd of the next month. This is requested a lot, because it matches their salary payment cycles. Likewise, it is not (and will not) be possible to have a 2-week, 4-week cycle, or a 13-week cycle. \n\nIn personal finances, I believe it is not a good idea to have your paycheck determine your schedule and thus, your life. If you are serious about saving money, you will want to have a fixed schedule that does not change. This way, you can plan ahead and make better decisions. I am opinionated on this topic, so Firefly III is as well.\n\nUsing a schedule (a monthly schedule is my favorite) you can track expenses and income in a reasonably long period, you can compare both months and seasons, and as a bonus the month itself will tell you how far along you are in your current cycle. \n\nTo learn more about this, see also the page on [personal finances](/explanation/firefly-iii/background/personal-finances/).\n",
      "documentId": "explanation/firefly-iii/background/time-periods",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/time-periods/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/firefly-iii/background/time-periods/index.md"
        }
      ]
    },
    {
      "id": "explanation/data-importer/introduction/index.md",
      "kind": "page",
      "title": "Firefly III Data Importer",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/introduction/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/introduction/index.md",
      "file": "explanation/data-importer/introduction/index.md",
      "searchText": "\n# Firefly III Data Importer {#firefly-iii-data-importer}\n\n\nThe Firefly III data importer can be used to import data into Firefly III. It is a [separate tool](/explanation/data-importer/separate-tool/) from Firefly III with \nits own [installation](/how-to/data-importer/installation/docker/) and [upgrade](/how-to/data-importer/upgrade/docker/) guides. \n\nThe importer can import [a number of file types](/how-to/data-importer/import/file/). It can also download transactions from several [third party data providers](/how-to/data-importer/import/third-party-providers/).\n\n\n### Can the data importer sync with my bank? {#can-the-data-importer-sync-with-my-bank}\n\n\nYes. The data importer uses several [third party data providers](/how-to/data-importer/import/third-party-providers/) to connect to a range of banks world wide. Please see the [configuration page](/how-to/data-importer/how-to-configure/) for configuration details.\n\nThere is also a [Firefly III API](/references/firefly-iii/api/) that you can connect to \\[YOUR BANK HERE\\], if you are clever enough to build something in your favorite programming language.\n\n\n### Can you clean-up the transactions from \\[my bank\\]? {#can-you-clean-up-the-transactions-from-my-bank}\n\n\nIf your bank delivers terrible files, or when the GoCardless import is exceptionally messy, there is not much I can do about it.\n\nThere are too many banks and financial institutions in the world for me to manage exceptions or options for. If you run into a data quality issue, the best place to get it addressed is at the source: your bank.\n\n\n### Will manually entered transactions match with imported bank transactions? {#will-manually-entered-transactions-match-with-imported-bank-transactions}\n\n\nProbably not. Most imported transactions have different fields with different values, which break the matching algorithm.\n\n\n### I want to auto-import transactions from \\[my bank\\] out of the box! {#i-want-to-auto-import-transactions-from-my-bank-out-of-the-box}\n\n\nThere are several ways to do this:\n\n1. [Using the CLI (and a cron job)](/how-to/data-importer/advanced/cli/)\n2. [Using the web (and a cron job)](/how-to/data-importer/advanced/post/)\n\n\n## Is the data importer multi-user? {#is-the-data-importer-multi-user}\n\n\nYes. It borrows login information from Firefly III using OAuth. To make sure it redirects to Firefly III, where you can log in, **do not** set the `FIREFLY_III_ACCESS_TOKEN` in the data importer environment variables. Use only the `FIREFLY_III_URL` variable. This way, each user must authenticate to the data importer.\n\nSome features are not available when you set up a multi-user data importer: you cannot use the POST import function, and you can't import over the command line.\n\nIf you use Firefly III with \"remote user authentication\" (for example Authelia) the data importer can only use personal access tokens. That means that it cannot be made multi-user.\n\nIn such cases, you must set up multiple data importers, one for each user.\n",
      "documentId": "explanation/data-importer/introduction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/introduction/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/introduction/index.md"
        }
      ]
    },
    {
      "id": "explanation/data-importer/separate-tool/index.md",
      "kind": "page",
      "title": "Separate tool",
      "description": "I turned the data importer into a separate tool. It allows me to keep track of two different tools with different development requirements.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/separate-tool/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/separate-tool/index.md",
      "file": "explanation/data-importer/separate-tool/index.md",
      "searchText": "\n# Separate tool {#separate-tool}\n\n\n\n## Why isn't the data importer built into Firefly III? {#why-isnt-the-data-importer-built-into-firefly-iii}\n\n\nI turned the data importer into a separate tool. It allows me to keep track of two different tools with different development requirements.\n\n\n## Why isn't this a plugin, like WordPress? {#why-isnt-this-a-plugin-like-wordpress}\n\n\nIt adds a whole layer of complexities to Firefly III. A plugin needs a framework to land in. For the data importer to be a plugin, I would first have to build it so Firefly III supports plugins. And then the data importer would be the only plugin.\n\nThe [API](/references/firefly-iii/api/) is a plugin system of sorts.\n",
      "documentId": "explanation/data-importer/separate-tool",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/separate-tool/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/separate-tool/index.md"
        }
      ]
    },
    {
      "id": "explanation/data-importer/ignored-values/index.md",
      "kind": "page",
      "title": "Ignored values",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/ignored-values/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/ignored-values/index.md",
      "file": "explanation/data-importer/ignored-values/index.md",
      "searchText": "\n# Ignored values {#ignored-values}\n\n\nThe data importer wil sometimes ignore data from Spectre or GoCardless. In the notes of the transaction, you will see something like this:\n\n![An example error message](/_media/d3ad8dac0872a6eed1d8.png)\n\nThe 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.\n\nSome banks pretend the source and destination accounts of a transaction are the same. This is not supported in Firefly III so the data importer changes either the source or the destination to another, generic account. For your convenience, the ignored data is stored in the notes of the transaction.\n",
      "documentId": "explanation/data-importer/ignored-values",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/data-importer/ignored-values/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/data-importer/ignored-values/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/logo/index.md",
      "kind": "page",
      "title": "Firefly III logo and name",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/logo/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/logo/index.md",
      "file": "explanation/more-information/logo/index.md",
      "searchText": "\n# Firefly III logo and name {#firefly-iii-logo-and-name}\n\n\n<div style=\"text-align:center;\">\n\t<img src=\"/_media/50a8ac0ea7c4d1e62489.png\" style=\"height:200px;\" alt=\"Firefly III logo\">\n\t<h2>Firefly III</h2>\n</div>\n\nThe name of this tool is \"Firefly III\". It was named after the [Fairey Firefly](https://en.wikipedia.org/wiki/Fairey_Firefly) because at the time all my project names were British airplanes from the WW2 era.\n\n\"Firefly\" was the original iteration of this tool, and no longer exists. I started building \"Firefly Mark 2\" in Groovy (a Java dialect) but quickly gave up. \"Firefly III\" is my third and final attempt, and at the time I thought the \"III\" would make it sound cool. There will not be a Firefly IV or Firefly V.\n\nSo it's called \"Firefly III\" because this is the third major iteration of the original \"Firefly\". Many people tend to use \"Firefly\" and \"Firefly III\" interchangeably, although I tend to stick to \"Firefly III\" myself.\n\nOn my request, the Firefly III logo was designed exclusively for Firefly III by the excellent Cherie Woo.\n\nThis page explains how you use the logo and Firefly III name in a way that fits Firefly III. In most cases, you’ll need to get my permission first. The logo is copyrighted, obviously.\n\n\n## General usage {#general-usage}\n\n\nHere's the thing: I don't generally mind people using the logo for their own tools and things. I wrote Firefly III as open source software under a copyleft license for a good reason. Spread the word!\n\nI have however, on occasion, noticed subpar tools and things that are suddenly \"my responsibility\" because they carry the logo or call themselves \"Firefly III\". That's **not** going to fly. I would like to be responsible for my own subpar tools only, thank you very much.\n\n\n### Talk about, not as, Firefly III {#talk-about-not-as-firefly-iii}\n\n\nIf you want to use the \"Firefly III\" name, use something like \"Cool Tool for Firefly III\". There is only one application called Firefly III, and it's [this application](https://github.com/firefly-iii/firefly-iii/). Prevent confusion and use another name.\n\n\n## The logo {#the-logo}\n\n\n* Logo as [PNG](/_media/50a8ac0ea7c4d1e62489.png) / [SVG](/_media/0384d21d627d51a1ad4f.svg)\n* Logo as [PNG](/_media/019488e6203789b363bd.png) / [SVG](/_media/30f0fa2adac53d958671.svg) (with a flame effect)\n\nThe Firefly III is a canvassed piggy, surrounded by a flame. The tail is inverted \"into\" the piggy. The main color of the logo is #CD5029. You may recognize the butt of the piggy in the favicon of Firefly III.\n\nUse the logo to refer to Firefly III and the associated tools.\n\nAlways download the official logo from this page. Don’t modify the graphics or use modified versions you might find on the internet. Do not modify the logo to use it in your own project. Do not use part of the logo in your own project. Don’t use the logo in a way that suggests partnership or endorsement by Firefly III.\n\nIf you think you should be an exception, please ask me first.\n\n\n## Colours {#colours}\n\n\nFirefly III uses a few colors in the layouts and pages etc.\n\n<style type=\"text/css\">\n\n/* Palette color codes */\n/* Feel free to copy&paste color codes to your application */\n\n.primary-1 { background-color: #FFA284 }\n.primary-2 { background-color: #DF7351 }\n.primary-0 { background-color: #CD5029 }\n.primary-3 { background-color: #A33614 }\n.primary-4 { background-color: #7B1E00 }\n\n.secondary-1-1 { background-color: #588FA4 }\n.secondary-1-2 { background-color: #36758C }\n.secondary-1-0 { background-color: #1E6581 }\n.secondary-1-3 { background-color: #104F66 }\n.secondary-1-4 { background-color: #03394D }\n\n.secondary-2-1 { background-color: #A5E376 }\n.secondary-2-2 { background-color: #7FC648 }\n.secondary-2-0 { background-color: #64B624 }\n.secondary-2-3 { background-color: #499012 }\n.secondary-2-4 { background-color: #2F6D00 }\n\n/* end */\n.color-table {\n\tmargin: 2em 2em 5em;\n\tborder-collapse:collapse;\n\tborder:none;\n\twidth:100%;\n\tborder-spacing:0;\n\tfont-size:100%;\n\t}\n.color-table th {\n\tpadding: 0 1em 0 0;\n\tvertical-align: middle;\n\tfont-size: 100%;\n\tfont-weight: normal;\n\tborder: none;\n\t}\n.color-table td.sample {\n\twidth:6em; height:6em;\n\tpadding: 10px;\n\ttext-align:center;\n\tvertical-align:middle;\n\tfont-size:90%;\n\tborder: 1px solid white;\n\twhite-space:nowrap;\n\t}\n.color-table td.sample-0 {\n\twidth:18em;\n\t}\n.color-table.small td.sample {\n\twidth:3em; height:3em;\n\tpadding:0;\n\tborder:none;\n\t}\n.color-table.small td.sample-0 {\n\twidth:9em;\n\t}\n.color-table .white { margin-bottom:0.2em; color:white }\n.color-table .black { margin-top:0.2em; color:black }\n\n</style>\n\n<table class=\"color-table\">\n\t<tbody><tr>\n\t\t<th colspan=\"5\">Primary color</th>\n\t\t</tr>\n\t\t<tr>\n\t\t<td class=\"sample sample-1 primary-1\">\n\t\t\t<div class=\"white\">#FFA284</div>\n\t\t\t<div class=\"black\">#FFA284</div>\n\t\t</td>\n\t\t<td class=\"sample sample-2 primary-2\">\n\t\t\t<div class=\"white\">#DF7351</div>\n\t\t\t<div class=\"black\">#DF7351</div>\n\t\t</td>\n\t\t<td class=\"sample sample-0 primary-0\">\n\t\t\t<div class=\"white\">#CD5029</div>\n\t\t\t<div class=\"black\">#CD5029</div>\n\t\t</td>\n\t\t<td class=\"sample sample-3 primary-3\">\n\t\t\t<div class=\"white\">#A33614</div>\n\t\t\t<div class=\"black\">#A33614</div>\n\t\t</td>\n\t\t<td class=\"sample sample-4 primary-4\">\n\t\t\t<div class=\"white\">#7B1E00</div>\n\t\t\t<div class=\"black\">#7B1E00</div>\n\t\t</td>\n\t</tr>\n\t<tr>\n\t\t<th colspan=\"5\">Secondary color (1)</th>\n\t</tr>\n\t<tr>\n\t\t<td class=\"sample sample-1 secondary-1-1\">\n\t\t\t<div class=\"white\">#588FA4</div>\n\t\t\t<div class=\"black\">#588FA4</div>\n\t\t</td>\n\t\t<td class=\"sample sample-2 secondary-1-2\">\n\t\t\t<div class=\"white\">#36758C</div>\n\t\t\t<div class=\"black\">#36758C</div>\n\t\t</td>\n\t\t<td class=\"sample sample-0 secondary-1-0\">\n\t\t\t<div class=\"white\">#1E6581</div>\n\t\t\t<div class=\"black\">#1E6581</div>\n\t\t</td>\n\t\t<td class=\"sample sample-3 secondary-1-3\">\n\t\t\t<div class=\"white\">#104F66</div>\n\t\t\t<div class=\"black\">#104F66</div>\n\t\t</td>\n\t\t<td class=\"sample sample-4 secondary-1-4\">\n\t\t\t<div class=\"white\">#03394D</div>\n\t\t\t<div class=\"black\">#03394D</div>\n\t\t</td>\n\t</tr>\n\t<tr>\n\t\t<th colspan=\"5\">Secondary color (2)</th>\n\t</tr>\n\t<tr>\n\t\t<td class=\"sample sample-1 secondary-2-1\">\n\t\t\t<div class=\"white\">#A5E376</div>\n\t\t\t<div class=\"black\">#A5E376</div>\n\t\t</td>\n\t\t<td class=\"sample sample-2 secondary-2-2\">\n\t\t\t<div class=\"white\">#7FC648</div>\n\t\t\t<div class=\"black\">#7FC648</div>\n\t\t</td>\n\t\t<td class=\"sample sample-0 secondary-2-0\">\n\t\t\t<div class=\"white\">#64B624</div>\n\t\t\t<div class=\"black\">#64B624</div>\n\t\t</td>\n\t\t<td class=\"sample sample-3 secondary-2-3\">\n\t\t\t<div class=\"white\">#499012</div>\n\t\t\t<div class=\"black\">#499012</div>\n\t\t</td>\n\t\t<td class=\"sample sample-4 secondary-2-4\">\n\t\t\t<div class=\"white\">#2F6D00</div>\n\t\t\t<div class=\"black\">#2F6D00</div>\n\t\t</td>\n\t</tr>\n</tbody></table>\n",
      "documentId": "explanation/more-information/logo",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/logo/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/logo/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/architecture/index.md",
      "kind": "page",
      "title": "Architecture",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/architecture/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/architecture/index.md",
      "file": "explanation/more-information/architecture/index.md",
      "searchText": "\n# Architecture {#architecture}\n\n\nOn 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.\n\n\n## Database {#database}\n\n\n![Basic database structure](/_media/0e0f8a170a2e4394ed9f.png)\n\n![Webhooks](/_media/451803eb7d98d3309648.png)\n\n![Rules](/_media/35b8e068d4f64404d33f.png)\n\n![Recurring transactions](/_media/441d08c2d0534c33a348.png)\n\nThese images show you a graphical overview of the most important parts of the database. There are many more tables, but these are the important objects you may want to learn about. If you see something in the database you're curious about, please let me know.\n\n\n### Transactions {#transactions}\n\n\nIn the picture, objects related to transactions are shown in shades of red. A \"transaction group\" ties multiple \"transaction journals\" together. Each transaction journal contains exactly two transactions. A transaction either removes or adds money from an account. A basic withdrawal or expense in Firefly III consists of:\n\n- One transaction group to tie everything together.\n- One transaction journal to link two transactions.\n- One transaction removing money from account A.\n- One transaction adding money to account B.\n\nA split transaction is one \"transaction group\" that contains *X* \"transaction journals\", one for each split. Each transaction journal contains two transactions. The amount of the withdrawal is stored in the transaction.\n\nAccounts and transaction journals can have a currency assigned to it. Transaction journals may also have a \"foreign\" currency assigned to it, which is another reference to a currency object.\n\nTransaction journals have metadata like categories, budgets and bills and tags.\n\nAccounts are linked to transactions and to piggy banks. A transfer (see transaction type) may link a transaction journal to a piggy bank in a piggy bank event. Together they form the history of the piggy bank. A piggy bank event may exist without a link to a transaction journal.\n\n\n### Rules {#rules}\n\n\nRule groups contain rules. Rules have actions and triggers. Although actions and triggers may reference to budgets, categories and tags and other things, there is no database relationship.\n\n\n### Recurring transactions {#recurring-transactions}\n\n\nA recurring transaction has some basic information, and an X number of transactions, which means it's possible to make a \"split\" recurring transaction. It's also possible to create multiple \"repetitions\", that define when a recurrence fires. This data is used by the recurring cronjob to create the exact transaction as defined in the transaction definition, whenever a repetition says it's time.\n\n\n### Webhooks {#webhooks}\n\n\nWebhooks have a related object called the \"webhook message\" that contains the content of that particular moment the webhook fired and if it succeeded.\n\n\n## Code {#code}\n\n\nFirefly III is based on [Laravel](https://laravel.com/), and uses the MVC model. There is a number of design patterns used throughout the code. Listed here are the most important *directories* and what they contain. Some design patterns use more directories than what you see here, so be sure to also check out the [Design Patterns](#design-patterns) below.\n\n\n### Why PHP%PHPVERSION and not (some earlier version)? {#why-phpphpversion-and-not-some-earlier-version}\n\n\nMany operating systems and web hosters provide earlier or even old versions of PHP. So, why not stick to something stable, like PHP (minus two versions ago)? The answer is simple: I like the new features, syntax and possibilities. I've spent a lot of time in my professional life maintaining old apps written in PHP5, and never again. Thanks to containerization tools like Docker, individual PHP versions matter less than they used to do. \n\nEspecially the last few years, PHP has added a lot of cool stuff that I am eager to learn and work with. And I believe it helps to push the rest of the community away from old versions. I really do appreciate the stability other distros offer, but that's not for me.\n\n\n### Models {#models}\n\n\nModels are stored in [`Models/`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Models). Everything in the Firefly III database has an associated model. Most models also have a `routeBinder` function that tells if a URL parameter is valid. Some tables in the database are used to link data together, which means they don't have a model.\n\n\n### Views {#views}\n\n\nAll the views are stored in [`views/`](https://github.com/firefly-iii/firefly-iii/tree/main/resources/views). The v2 folder contains the views for the new layout, which will be a AlpineJS app. As such the v2 views are fairly basic (empty). Views are Twig files, but v2 views are Blade files.\n\n\n### Controllers {#controllers}\n\n\nMost pages are generated by controllers in [`Controllers/`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Http/Controllers). They're grouped around objects (rules, transactions, etc.) and mostly follow a CRUD-model.\n\n- IndexController\n- CreateController\n- *etc...*\n\nThere are specific controllers for the charts, some JSON controllers and some notable exceptions. Most of this code will have to move to the API, because I plan to make the new layout (v2) API-only. That means that the controllers in the [`app/Api/V1`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Api/V1) directory will become leading.\n\n\n### API {#api}\n\n\nThe API code is stored in [`app/Api/V1`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Api/V1) and consists of controllers, some basic middleware and request classes. The API code is pretty consistent: store or update objects, make some lists and transform the data into JSON. The requests can be interesting because in those requests the rules are stored that define what you can submit. The API will become the main interaction method for ALL frontend code in Firefly III, which means it will have to be greatly expanded.\n\n\n### Generators {#generators}\n\n\n- The Chart generators in [`app/Generator`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Generator) render specific arrays into chart.js compatible arrays (which in turn, are returned to the user as JSON).\n- The Report generators in [`app/Generator`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Generator) are kind of deprecated. They used to generate one huge array with the report in it that the user requested. This got slow, so now the generators only do the basic stuff. Each box on your favorite report is requested using AJAX / JSON from a dedicated controller in [`app/Http/Controllers/Report`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Http/Controllers/Report). This feels a lot snappier.\n- The Webhook generator is a small piece of code that generates the actual message used in webhooks.\n\n\n### Helpers {#helpers}\n\n\nThe [`app/Helpers`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Helpers) contains some generic code used for reports, the help, and updates. It's a place for all of those things I couldn't think of a better place for. The transaction collector is kind of special and is detailed in another section.\n\n\n### Jobs {#jobs}\n\n\nSome of the work that Firefly III needs to do is complex or time-consuming, so it's packed in a job. In [`app/Jobs`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Jobs) you'll find some things either triggered by cron jobs or by other things.\n\n\n### Validation rules {#validation-rules}\n\n\nValidation rules are stored in [`app/Rules`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Rules) and [`app/Validation`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Validation). It's one thing to validate if a number is larger than zero. But some validation rules for transactions used by Firefly III are pretty complex, because there's a lot of context.\n\n\n### Services {#services}\n\n\nThe idea of [`app/Services`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Services) was that any external service would have its code and interfaces in this folder. This applies to the update checker, the webhooks and the password verifier. However, there's also a few \"internal\" services. Creating a transaction or account from beginning to end is complex so these services tie it all together.\n\n\n### Support classes {#support-classes}\n\n\nIn the [`app/Support`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Support) directory you will find a bunch of support code for all kinds of functions and things in Firefly III. Just like the [`app/Helpers`](https://github.com/firefly-iii/firefly-iii/tree/main/app/Helpers) folder it seems to collect all kinds of code snippets that have nowhere else to go.\n\n\n### Translations {#translations}\n\n\nAll languages are stored in [`resources/lang`](https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang). The main language is [`en_US`](https://github.com/firefly-iii/firefly-iii/tree/main/resources/lang/en_US), all other translations are derived from the English text. If you want to support the translations, check out [Crowdin](https://crowdin.com/project/firefly-iii).\n\n\n## Design Patterns {#design-patterns}\n\n\nApart from the [code](#code) in the previous section there are some design patterns in use that don't really focus on specific folders specifically but rather have a design that spans more than one part of the code base.\n\n\n### Transaction collection, search and rules {#transaction-collection-search-and-rules}\n\n\nThe single biggest piece of code in Firefly III is the **transaction collector**. This is an interface with lots of functions that is designed to collect (you guessed it) transactions. In the code you give the collector parameters like [date-ranges, accounts or search queries](https://github.com/firefly-iii/firefly-iii/blob/main/app/Api/V1/Controllers/AccountController.php#L265). You then collect the [results](https://github.com/firefly-iii/firefly-iii/blob/main/app/Api/V1/Controllers/AccountController.php#L277) and use it in lists, or in rule actions or whatever. This is basically [one big database query](https://github.com/firefly-iii/firefly-iii/blob/main/app/Helpers/Collector/GroupCollector.php#L179).\n\nThere are two schools of thought when it comes to transaction collection. Each page, each view and each report has its own set of transactions it wants to show *and* a specific set of meta-data it needs. In earlier times each controller would have its own code to grab transactions from the database. This is very hard to maintain, although it makes each query very efficient. A transaction collector is less effective than writing dedicated queries, but it does save a lot of code.\n\nCheck out the [`GroupCollectorInterface.php`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Helpers/Collector/GroupCollectorInterface.php) for all the possibilities.\n\nThere is an [`OperatorQuerySearch`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Search/OperatorQuerySearch.php) class stored in [`app/Support/Search`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Search) that converts the search query of the user into a transaction collector. The collector does its work and the result is shown to the user.\n\nStored in the folder [`app/TransactionRules/Engine`](https://github.com/firefly-iii/firefly-iii/tree/main/app/TransactionRules/Engine) is the [rule engine](https://github.com/firefly-iii/firefly-iii/blob/main/app/TransactionRules/Engine/SearchRuleEngine.php). It works just like the search does. It uses the rule triggers to build [a search query](https://github.com/firefly-iii/firefly-iii/blob/3ed4d28c4aafdf9478d7bcb12a268b67d0837419/app/TransactionRules/Engine/SearchRuleEngine.php#L315). The [query](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Search/OperatorQuerySearch.php#L194) is executed by the transaction collector. The transactions that are found are then handled by the actions in the [`Actions`](https://github.com/firefly-iii/firefly-iii/tree/main/app/TransactionRules/Actions) folder. The engine ties all of this together.\n\n\n### Events {#events}\n\n\nSome events in Firefly III trigger more code. File [`EventServiceProvider.php`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Providers/EventServiceProvider.php) shows you all events (also listed in [`app/Events`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Events)) and the class + method that will trigger if the event happens. Some events trigger multiple handlers. The code of the handlers is in [`app/Handlers`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Handlers).\n\n\n### Factories {#factories}\n\n\nMost objects in Firefly III are complicated things. Just look at the structure of a transaction. In a worst-case scenario a new split withdrawal results in 13 new objects. The various factories in [`app/Factory`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Factory) handle this. If you start with the [`TransactionGroupFactory`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Factory/TransactionGroupFactory.php) you can go down the rabbit hole of transaction creation in Firefly III.\n\n\n### Webhooks {#webhooks_1}\n\n\nWhen selected events happen (currently: when a transaction is stored or updated) Firefly III creates a new [`StandardMessageGenerator`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Generator/Webhook/StandardMessageGenerator.php) that will generate a new webhook message for every active webhook that is applicable to the current event.\n\nAfter the generator generates the messages another trigger is fired that will send the messages. The [`WebhookEventHandler`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Handlers/Events/WebhookEventHandler.php) will select a maximum of 3 webhook messages that haven't failed too often. This means that message generation, message selection, and message sending are three separate processes.\n\nSo actually sending a webhook message is another separate job (see [`SendWebhookMessage`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Jobs/SendWebhookMessage.php)) which means that it can be done asynchronously. The [`StandardWebhookSender`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Services/Webhook/StandardWebhookSender.php) will use the [`Sha3SignatureGenerator`](https://github.com/firefly-iii/firefly-iii/blob/main/app/Helpers/Webhook/Sha3SignatureGenerator.php) to sign the message and send it (using Guzzle).\n\nThe result is stored in the original webhook message in the database.\n\n\n### Repositories {#repositories}\n\n\nThe [repository](https://github.com/firefly-iii/firefly-iii/tree/main/app/Repositories) design pattern basically says that you don't query your models directly but ask a repository to list or create what you need, and then the repository takes care of it. It's a weird pattern because usually you have this repository interface and just a single implementation making the interface kind of overhead. But I like the idea.\n\nThese repositories do a lot of the heavy lifting when it comes to specific models and their demands from various parts of the code (search for, list, summarize). The \"store\"- and \"update\"-methods that these repositories contain are mostly taken over by factories.\n\n\n### Frontend {#frontend}\n\n\nThe [`/frontend`](https://github.com/firefly-iii/firefly-iii/tree/main/frontend) folder contains the code of the new Vue frontend. Check out `src` for all the details. It's a Vue based frontend build using Quasar.\n",
      "documentId": "explanation/more-information/architecture",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/architecture/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/architecture/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/security/index.md",
      "kind": "page",
      "title": "Firefly III security",
      "description": "Because Firefly III stores personal financial information it's important to know how Firefly III is secured, and how it's not.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/security/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/security/index.md",
      "file": "explanation/more-information/security/index.md",
      "searchText": "\n# Firefly III security {#firefly-iii-security}\n\n\nBecause Firefly III stores personal financial information it's important to know how Firefly III is secured, and how it's not.\n\n\n\n> [!CAUTION]\n> If you find a security issue or problem with Firefly III, please refer to the [Security Policy](https://github.com/firefly-iii/firefly-iii/security/policy).\n\n\n\n\n## Database {#database}\n\n\nThe database is not encrypted, and data in the tables of the database is readable for humans. Use a strong password to authenticate to the database and create a dedicated user for the Firefly III database. Whenever possible, use the disk encryption feature of your operating system to encrypt the disk on which the database is stored.\n\nWhen you connect your Firefly III instance to the internet, ensure that the database can't be connected to from the web, but only from localhost. Preferably, the database host can only be reached from the Firefly III host.\n\nID's used for objects in Firefly III are incremental numbers. Logged-in users may infer the existence of objects owned by other users by changing the ID in the address bar and observing 404's. This is not possible for guests.\n\nUp until [Firefly III v4.7.9](https://github.com/firefly-iii/firefly-iii/releases/tag/4.7.9) (December 2018) the database was partially encrypted by Firefly III. Descriptions and other values were encrypted using AES and decrypted transparently. This adds security because if the database is taken, the values are unreadable without the key. This is no longer the case.\n\n\n## Sessions and logins {#sessions-and-logins}\n\n\nSessions are not tied to an IP address. Use 2FA when you can, which is a feature of Firefly III. There is a button on the `/profile` page that allows you to logout other sessions, so you can ensure there's a limited number of logged-in sessions out there.\n\nAfter the first user has registered themselves, future registrations are blocked. It can be enabled again under `/settings/configuration`. Each user is strictly separated from other users. Users can't see or detect other users, although they can infer their existence through their user ID (see the preceding text).\n\nThe very first user who registers on your instance of Firefly III gets assigned the \"owner\"-role. Users with the \"owner\" role can block other users, make them owner as well, but also change their password and/or email address.\n\nLogin attempts are capped; guests can't brute-force their way in.\n\nWhen a user logs in from a new IP address they will be sent an email.\n\n\n## Personal information {#personal-information}\n\n\nWhen logged out, Firefly III will not leak personal information. There is no identifying information in the pages that are available to guest users. The reset password option will not confirm if accounts exist.\n\n\n## Privacy {#privacy}\n\n\nFirefly III has several options and features that contact other servers on the internet.\n\n- When registering, Firefly III uses the [Have I Been Pwnd password API (v3)](https://haveibeenpwned.com/API/v3#PwnedPasswords) to verify if you're using a secure password. You can disable this when registering an account.\n- Firefly III can *optionally* contact [version.firefly-iii.org](https://version.firefly-iii.org) to check for new versions. This is a Linux machine hosted on Azure.\n- Firefly III can *optionally* download and view mapdata generated by [Mapbox](https://www.mapbox.com/).\n- Firefly III can *optionally* use a user configurable Matomo installation to track user behavior on Firefly III. This is used on the demo site.\n- Firefly III can *optionally* download currency exchange rate information [an Azure bucket](https://github.com/firefly-iii/exchange-rates).\n\nOtherwise, Firefly III contacts no outside servers and will not download JS libraries or fonts. Headers added to each page will prevent Firefly III from running outside scripts.\n\n\n## Storage {#storage}\n\n\nFirefly III stores all uploaded attachments unencrypted in the `/storage/upload` directory. Users who have permissions to the file system will be able to get uploaded attachments for all users.\n\n\n## Encryption {#encryption}\n\n\nNo encryption of data-at-rest is used. Use your operating system's disk encryption features for further protection of data-at-rest. For data-in-transit, see TLS below.\n\nA public/private keypair is generated to be used for the signing of API keys (Personal Access Tokens and OAuth Clients). This keypair is stored under `/storage` and has no further protection. There are instructions in the `.env.example` to provide your own key material.\n\n\n## Export {#export}\n\n\nLogged-in users can download an export of their data from the user interface (under `/export`). On the command line, users can export data and store it in any directory writeable to the user using the `firefly-iii:export-data` command. To use this command you'll need a special access token, which can be found under the `/profile` page. This token is strictly personal.\n\n\n## TLS {#tls}\n\n\nFirefly III does not come with TLS enabled. This is up to you to set up. It does support it, however. The Docker image can be protected using a reverse proxy setup, where the reverse proxy enables TLS. When self-hosting, this is up to you to configure.\n\nFirefly III supports an SSL connection to the database, when using MySQL or PostgreSQL. This is disabled by default.\n\n\n## Docker secrets {#docker-secrets}\n\n\nAll secrets in use by Firefly III are stored in environment variables. These are offered to Firefly III by using actual environment variables (preferred), by using the `.env` file or by using Docker's feature to share environment variables with Firefly III.\n\nFirefly III supports the use of files for secrets (see the `.env.example` file). Sensitive information used to run Firefly III should not be stored in plaintext. Check out [Docker secrets](https://docs.docker.com/engine/swarm/secrets/).\n\nYes, 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](https://forums.docker.com/t/only-root-user-has-access-to-the-secret/102774) and detailed [in this GitHub discussion](https://github.com/orgs/firefly-iii/discussions/9788).\n\n\n## XSRF and XSS {#xsrf-and-xss}\n\n\nEach form in Firefly III is protected by a token preventing cross site request forging. All javascript on Firefly III pages must also be called with a special token to prevent cross-site scripting.\n\nFirefly III is thus prevented from executing unexpected Javascript in case of newly discovered SQL injection or forgotten escaping.\n\n\n## Debug {#debug}\n\n\nWhen you set the `APP_DEBUG` environment variable to `true`, Firefly III will leak an amazing amount of private data when it encounters a bug. This includes secrets and passwords.\n\nBugs may also appear (and thus leak sensitive information) on pages not protected by a user login. An example would be the password reset page: misconfigured email settings may expose sensitive information when Firefly III reports the issue through an error page.\n\n\n## Logging {#logging}\n\n\nBy default, Firefly III outputs its logs to `stdout` and to a file in `/storage/logs`. That means that users who have permission to read these files or permission to the Docker engine can trace the log files and extract personal information from them. You can set the `APP_LOG_LEVEL` to `error` to prevent the logging of most information or to `emergency` to prevent the logging of any information. When using Docker, keep in mind that Apache2 will keep logging each http request.\n\nEven logging just error information may leak data.\n\n\n## Security bugs and issues {#security-bugs-and-issues}\n\n\n\n\n> [!CAUTION]\n> If you find a security issue or problem with Firefly III, please refer to the [Security Policy](https://github.com/firefly-iii/firefly-iii/security/policy).\n\n\n\n\n## Other stuff {#other-stuff}\n\n\nIf you have more questions regarding the security of Firefly III, or how to secure your Firefly III installation, please [contact me directly](mailto:james@firefly-iii.org) or open [a ticket on GitHub](https://github.com/firefly-iii/firefly-iii/issues/new/choose).\n\n\n",
      "documentId": "explanation/more-information/security",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/security/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/security/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/license/index.md",
      "kind": "page",
      "title": "The Firefly III license",
      "description": "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\".",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/license/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/license/index.md",
      "file": "explanation/more-information/license/index.md",
      "searchText": "\n# The Firefly III license {#the-firefly-iii-license}\n\n\nFirefly 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](https://www.gnu.org/licenses/agpl-3.0.html.en). It's abbreviated as \"AGPLv3\".\n\nThe AGPLv3 license is a \"[copyleft](https://en.wikipedia.org/wiki/Copyleft)\" license. It grands you all kinds of freedom in relation to (copies of) Firefly III, with the requirement that the same rights be preserved in derivative works.\n\nYou are never allowed to remove the license from Firefly III's code.\n\n\n## Firefly III copyright {#firefly-iii-copyright}\n\n\nFirefly III is mostly copyrighted by me. PR's and other contributions are copyrighted to their respective owners. The open source license does not change the copyright. The code is not without copyright. It is licensed to you to use under the [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.html.en).\n\nYou are never allowed to remove the copyright notice from Firefly III's code.\n\n\n## Firefly III name and logo {#firefly-iii-name-and-logo}\n\n\nThere is a dedicated page that discusses [the name and logo of Firefly III](/explanation/more-information/logo/).\n\n\n## What can I do under the AGPLv3? {#what-can-i-do-under-the-agplv3}\n\n\nThe AGPLv3 allows you to do anything with the code you want, **IF and only IF** you release your changes under the AGPLv3 as well. This also applies to running a modified version of Firefly III on your webserver: you must make the source code available to the users.\n\nThe full details of what you can do are in the [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.html.en). The license is leading, no matter what this page tells you.\n\n\n## Questions {#questions}\n\n\nI often get asked the same questions, so here are the answers.\n\n\n### Can I run a commercial (hosted) version of Firefly III? {#can-i-run-a-commercial-hosted-version-of-firefly-iii}\n\n\nThat is OK. Any changes you make to Firefly III need to be made open source under the AGPLv3. That means hosting a repository somewhere with the source code of your hosted version.\n\n\n### Can I pay you to do the development of custom feature X for me? {#can-i-pay-you-to-do-the-development-of-custom-feature-x-for-me}\n\n\nYes. However, the code will be released under the AGPLv3 as well. And if I like the feature I will definitely port it back to Firefly III. Having said that, I currently do not have the time to do more development than I already do, paid or not. So if you ask me, the answer is probably \"no\".\n\n\n### Can I pay somebody else to do custom development on Firefly III? {#can-i-pay-somebody-else-to-do-custom-development-on-firefly-iii}\n\n\nYes. Anybody can fork and change Firefly III. If you want a specific feature, but you're not a developer, you can pay somebody to build it for you. But the code must also be released publicly under the AGPLv3. That means hosting a repository somewhere with the source code of \"Firefly III + my cool changes\".\n\n\n### Can I white-label Firefly III and sell it as \"My Awesome Finance App\"? {#can-i-white-label-firefly-iii-and-sell-it-as-my-awesome-finance-app}\n\n\nThat is OK. Any changes you make to Firefly III need to be made open source under the AGPLv3. That means hosting a repository somewhere with the source code of \"My Awesome Finance App\".\n\n\n### Can I change Firefly III, so it can be used by commercial businesses, and sell it? {#can-i-change-firefly-iii-so-it-can-be-used-by-commercial-businesses-and-sell-it}\n\n\nThat is OK. Any changes you make to Firefly III need to be made open source under the AGPLv3. That means hosting a repository somewhere with the code of \"Firefly III + business expansions\".\n\n\n### Can I build something \"inspired by\" Firefly III? {#can-i-build-something-inspired-by-firefly-iii}\n\n\nThat is OK. Any changes you make to Firefly III need to be made open source under the AGPLv3. That means hosting a repository somewhere with the code.\n\nA special exception here: if you don't actually use or change Firefly III code, you are not required to open source your code. That means that your new app does not need to be AGPLv3. Keep in mind there are rules regarding [the name and logo of Firefly III](/explanation/more-information/logo/).\n\n\n### Can I build a (mobile) app that connects to Firefly III? {#can-i-build-a-mobile-app-that-connects-to-firefly-iii}\n\n\nThat is OK. Any changes you make to Firefly III need to be made open source under the AGPLv3. That means hosting a repository somewhere with the code.\n\nA special exception here: if you don't actually use or change Firefly III code, you are not required to open source your code. That means that your new app does not need to be AGPLv3. Keep in mind there are rules regarding [the name and logo of Firefly III](/explanation/more-information/logo/).\n\n\n### Can I provide (paid) Firefly III support to people who ask me for it? {#can-i-provide-paid-firefly-iii-support-to-people-who-ask-me-for-it}\n\n\nThat is OK. You don't need to pay me.\n\n\n### I run Firefly III for my friends. Do I need to provide them source code? {#i-run-firefly-iii-for-my-friends-do-i-need-to-provide-them-source-code}\n\n\nThat is OK. If you run an unchanged version of Firefly III, you do not need to provide the source code: it is already available at GitHub. Any changes you make to Firefly III need to be made open source under the AGPLv3.\n\n\n## I have another question {#i-have-another-question}\n\n\nFeel free to [contact me](/explanation/support/). On the whole, the answer is probably simple: any changes you make to Firefly III need to be made open source under the AGPLv3.\n",
      "documentId": "explanation/more-information/license",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/license/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/license/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/donations/index.md",
      "kind": "page",
      "title": "Financial contributions",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/donations/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/donations/index.md",
      "file": "explanation/more-information/donations/index.md",
      "searchText": "\n# Financial contributions {#financial-contributions}\n\n\nFirefly 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](/explanation/more-information/license/). I am however, not adverse to a donation or a sponsorship.\n\n\n## Donations {#donations}\n\n\nI talk about the ability to donate on the introduction page of each repository, such as [the Firefly III repository](https://github.com/firefly-iii/firefly-iii/).\n\nDonations are a great way to support me and the work I do. Many people have donated to me over the years, and I'm very grateful for that. It's a great way to show your appreciation for the work I do. The money goes towards hosting costs, domain names, and various other expenses. It also goes towards the time I spend on the project. \n\nIf you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my **[Patreon](https://www.patreon.com/jc5)** and **[GitHub Sponsors](https://github.com/sponsors/JC5)** page for more information. You can also **[buy me a ☕️ coffee](https://ko-fi.com/Q5Q5R4SH1)** at ko-fi.com or use **[LiberaPay](https://liberapay.com/JC5)** to sponsor me. \n\nDonations are the only form of compensation I receive, apart of course from all your compliments and support. Thank you for your consideration.\n\n\n## VC money and capital injections from commercial organizations {#vc-money-and-capital-injections-from-commercial-organizations}\n\n\n\n\n> [!IMPORTANT]\n> **TL;DR**\n>\n> TL;DR: I will not be accepting VC money and capital injections from commercial organizations\n\n\n\nA few companies have approached me about turning (a part of) Firefly III into a commercial venture, a start-up. The \"personal finances\"-space such as it is, is rife with opportunity. Many people struggle financially and that's an interesting bandwagon to jump on. Getting people into your finance related platform has some advantages over other platforms (i.e. social media, calendar management, etc.):\n\n- You get loyal customers instantly, because if they trust YOU with their finances, they're not apt to switch quickly.\n- An onboarding process that feels complex but is surprisingly simple binds them to your platform (sunk cost fallacy).\n- You know their most intimate details (their finances) so their personal information can be sold for lots of money.\n- You can sell them financial products, like loans, insurances, mortgages, etc.\n- You can sell them other products, like cars, houses, etc.\n- You can sell them services, like financial advice, tax advice, etc.\n\nYour customers require just a marginally better insight in their finances than what their bank offers to make the switch. And if you can offer that, you're golden.\n\nIt's not a surprise then that many companies are interested in this space. I've been approached by a few of them. I've always declined, although I've considered it. But ultimately, I'm not interested in turning Firefly III into a commercial venture. Firefly III will not be turned into a commercial service or a VC-backed start-up. It's entirely possible to do this by the way, even without my consent. As long as you [keep all your code open source](/explanation/more-information/license/), nothing is stopping you from building a commercial platform based on Firefly III. *But I won't be the one to do so.*\n\nI started Firefly III with a single customer (me) and I will probably end up with a single customer (me). That's fine. I'm doing this for the fun of it. If your donations can give me half a day or more dedicated time to work on Firefly III, all the better. \n\n\n## Commercial support {#commercial-support}\n\n\nI've considered opening up the floor for commercial support. I.e. you pay me and I help you faster. But it's not something I get joy from, so that's probably not going to happen. I'll keep doing it for free on my own pace.\n\n\n## Free stuff {#free-stuff}\n\n\nBecause I work on open source software, several organisations give me access to products and product tiers which are usually reserved for paying customers.\n\n- Jetbrains gives me [an open source license for PHPStorm](https://www.jetbrains.com/community/opensource/)\n- GitHub gives me [free access to CoPilot](https://docs.github.com/en/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer#accessing-copilot-pro-for-free)\n- I am part of the [Docker Sponsored Open Source Program](https://www.docker.com/community/open-source/application/)\n- [TestMu AI](https://www.testmuai.com/?utm_source=fireflyiii&utm_medium=sponsor) sponsors me and gives me free access to their features.\n\nThank you all, for your support :-).\n\n\n## More questions? {#more-questions}\n\n\nIf you have more questions about this, please [let me know](/explanation/support/).\n",
      "documentId": "explanation/more-information/donations",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/donations/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/donations/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/what-its-not/index.md",
      "kind": "page",
      "title": "What Firefly III isn't",
      "description": "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 advance, if Firefly III isn't what you're looking for.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/what-its-not/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/what-its-not/index.md",
      "file": "explanation/more-information/what-its-not/index.md",
      "searchText": "\n# What Firefly III isn't {#what-firefly-iii-isnt}\n\n\nEven more important than all the stuff Firefly III [can do for you](/explanation/firefly-iii/about/introduction/) 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 advance, if Firefly III isn't what you're looking for.\n\nSometimes I can't or won't implement a certain feature, or change how something works. Let me reassure you this isn't personal or something. Also keep in mind that instead of offering options for everything I want Firefly III to have [sensible defaults](https://en.wikipedia.org/wiki/Convention_over_configuration).\n\nBut remember, there is a lot of things that you *can* do with Firefly III!\n\n\n### YNAB-style zero based budgeting {#ynab-style-zero-based-budgeting}\n\n\nBasically, YNAB allows you to assign each of your coin to a \"permanent\" budget, that you would replenish once your salary arrives. This way, zero based budgeting is about giving all your coins a goal and leaving no coin behind. Since Firefly III is fundamentally different, it will not be possible for Firefly III to support this. If you want, you can read my opinion on [zero based budgeting](/explanation/firefly-iii/background/zero-based-budgeting/).\n\n\n### Stock and portfolio management {#stock-and-portfolio-management}\n\n\nUnfortunately you won't be able to manage your stocks or portfolio with Firefly III. Use something like [Portfolio Performance](https://www.portfolio-performance.info/). The net worth you track in Firefly III would then exclude your portfolio, but you can consider creating an asset account and adding profit and losses as transactions.\n\n\n### Business finances, small business accounting, payroll management {#business-finances-small-business-accounting-payroll-management}\n\n\nMost features in Firefly III are geared towards personal finances. You should be able to get enough information for an invoice out of the API, but other features will not be added.\n\n\n### Advanced accounting and asset management {#advanced-accounting-and-asset-management}\n\n\nSome features from advanced programs like GNUCash don't work in Firefly III. It's hard to add \"objects\" to Firefly III. The monetary value of your house can't be added to your net worth (to compensate for your mortgage). If you want to do this, use [GNUCash](https://gnucash.org/) instead.\n\n\n### Prediction, forecasting, future gazing {#prediction-forecasting-future-gazing}\n\n\nFirefly III won't support the ability to predict expenses, give you a look into the future or do financial planning. The present is hard enough to manage. Although features like recurring transactions and some smart calculations would help, I find that quickly doing some math in Excel or Google Sheets works a lot better than whatever I could come up with.\n\n\n### Expand budget amounts by assigning deposits to budgets {#expand-budget-amounts-by-assigning-deposits-to-budgets}\n\n\nLet's say you have a budget of € 200,-. You spend the entire amount on PlayStation5 games, but you regret your purchase and return all of them. The money is returned to you as a deposit. You cannot assign the deposit to the budget and increase the budget so you have € 200,- available again. This is by design, and will not change.\n\nIt is up to you to (manually) decide if:\n\n1. You want to increase the budget to have the original amount available again.\n2. You want to change the original withdrawal so it is no longer tied to the budget, freeing the money.\n3. Deleting the original withdrawal to clear up the budget.\n\n\n### Sub-categories, sub-budgets, sub-accounts {#sub-categories-sub-budgets-sub-accounts}\n\n\nFirefly III knows many ways to organise your data, but there are no \"sublevels\". Instead, most objects like piggy banks or bills can be divided in \"groups\" which serve a similar purpose. There are also tags to make things very fine-grained.\n\n\n### Share your administration {#share-your-administration}\n\n\nFirefly III is a multi-user environment. But each user is strictly separated from other users. If you want to share your administration you must commit the capital sin of sharing your password. I am working on a better way to manage this however, and I ask for your patience.\n\n\n### Changing the monthly cycle to another day of the month. {#changing-the-monthly-cycle-to-another-day-of-the-month}\n\n\nA month goes from the 1st to the last day of the month. You can't tell Firefly III to go from the 23rd to the 22nd of the next month.\n\nFor more information on this, see also the page on [time periods](/explanation/firefly-iii/background/time-periods/) and [personal finances](/explanation/firefly-iii/background/personal-finances/).\n\n\n### Bi-weekly or four-weekly periods {#bi-weekly-or-four-weekly-periods}\n\n\nThis will not be added, sorry. The logic necessary to match whatever 2-week or 4-week period you need is to complex. If you get paid in 2 or 4-week intervals, consider changing your financial system to be monthly instead, instead of having your pay stubs determin your financial cadence.\n\n\n### More complicated rules, like Boolean logic, copy/pasting values, etc {#more-complicated-rules-like-boolean-logic-copypasting-values-etc}\n\n\nThe rule engine could be a lot more complex. Things like conditional rules, if-then-else, regular expressions or variables. These are all technically possible. However, the rule engine must also be usable and easy to be introduced to. Most rule engines, even the filters in GMail, are very complex because of user demands and as a result, nobody uses them anymore.\n\nFor Firefly III, the current features of the engine will not be expanded. If you have a suggestion, please consider that your suggested trigger or action is simple.\n",
      "documentId": "explanation/more-information/what-its-not",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/what-its-not/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/what-its-not/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/bending-and-breaking/index.md",
      "kind": "page",
      "title": "(Security) testing",
      "description": "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.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/bending-and-breaking/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/bending-and-breaking/index.md",
      "file": "explanation/more-information/bending-and-breaking/index.md",
      "searchText": "\n# (Security) testing {#security-testing}\n\n\nYou 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.\n\nIf you find anything, please refer to [the support page](/explanation/support/) and [the security policy](https://github.com/firefly-iii/firefly-iii/security/policy).\n\n\n## Testing on the demo site {#testing-on-the-demo-site}\n\n\n\n\n> [!WARNING]\n> **Using cURL and other tools**\n>\n> The server running the demo site detects and blocks most automated tools.\n\n\n\nPlease do not try to break things on [the demo site](/explanation/firefly-iii/about/demo/). Set up your own instance, and break that one instead. The demo site is for demoing, not for testing.\n\nIf I find you trying to break the demo site, I will ban your IP address.\n\nIf you have in fact been banned already and have been redirected to this page, please contact me if you feel this was in error. The [support page](/explanation/support/) has my contact details. \n\nThank you for allowing other users to try and test Firefly III without interference.\n\n",
      "documentId": "explanation/more-information/bending-and-breaking",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/bending-and-breaking/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/bending-and-breaking/index.md"
        }
      ]
    },
    {
      "id": "explanation/more-information/signatures/index.md",
      "kind": "page",
      "title": "Signed release files",
      "description": "Both the Firefly III and Data Importer releases are digitally signed.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/more-information/signatures/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/signatures/index.md",
      "file": "explanation/more-information/signatures/index.md",
      "searchText": "\n# Signed release files {#signed-release-files}\n\n\nBoth the Firefly III and Data Importer releases are digitally signed. \n\n- [Firefly III releases](https://github.com/firefly-iii/firefly-iii/releases)\n- [Data importer releases](https://github.com/firefly-iii/data-importer/releases)\n\nEach release is offered in two variants: A `zip` and a `tar.gz` file. These files are identical and contain the whole release and all meta files, dependencies, etc.\n\n\n## Verify the hash {#verify-the-hash}\n\n\nAvailable with each release is a file that ends with `.sha256`. There is one such file for both the `zip` and the `tar.gz` file. This file contains the SHA256 hash of the release file. This allows you to verify the release's integrity.\n\nTo do so, download both the release file and the `.sha256` file. Then, run the following command:\n\n```bash\n# Should return: \"FireflyIII-%FFVERSION.zip: OK\"\nsha256sum -c FireflyIII-%FFVERSION.zip.sha256\n\n# Should return: \"DataImporter-%IMPORTERVERSION.zip: OK\"\nsha256sum -c DataImporter-%IMPORTERVERSION.zip.sha256\n\n# alternative commands:\nshasum -a 256 -c FireflyIII-%FFVERSION.zip.sha256\nshasum -a 256 -c DataImporter-%IMPORTERVERSION.zip.sha256\n```\n\n\n### Why should I verify the integrity? {#why-should-i-verify-the-integrity}\n\n\nThis allows you to verify that you have downloaded the file right. It's not much of a problem these days, but back in the old days of intermittent connections, this was a valuable step to ensure data integrity.\n\n\n## Verify the signature {#verify-the-signature}\n\n\nTo make sure that the files aren't actually changed by a nefarious hacker, you can also verify the digital signature of the release. To do so, first download the relevant `.asc`-file, like `FireflyIII-%FFVERSION.zip.asc`.\n\n```bash\ngpg --verify FireflyIII-%FFVERSION.zip.asc FireflyIII-%FFVERSION.zip\ngpg --verify DataImporter-%IMPORTERVERSION.zip.asc DataImporter-%IMPORTERVERSION.zip\n```\n\nIt should say `Good signature`.\n\n\n### Why should I verify the signature? {#why-should-i-verify-the-signature}\n\n\nThis allows you to verify that the file is actually from the Firefly III project. This is a more secure way of verifying the integrity of the release. It's already harder to change both the release and the hash file, but if an attacker has access to the GitHub CDN, it's not impossible. However, forging a signature is impossible. \n\n\n## Releases (public key) {#releases-public-key}\n\n\nHere is the public key with which the releases are signed. It is also available [on a key server](https://keys.openpgp.org/search?q=A9D6BE866CEE3775854B1F96910CF2B5E8B6CC6E).\n\n```plaintext\n-----BEGIN PGP PUBLIC KEY BLOCK-----\n\nmQINBGYbtZ8BEACkhzatOWVOLMJs8GyCtuaorr11/fQ5O0yYp1Iw8AyGa1AbMZ3G\nRT6QWSNxSoO3kH9d7wF+O2jfcEgsoqaomV0VQT35y3k6qQGsdAYTl4FgI0Q86j2H\nOaEHniO6yafchHvSgAQs5BnTrbsagInxo3gZIX9hStqhCwxfc1G2nN6wH2RS3+Qe\nzr9/I1baE1JMF1S7q50EQRO7CyeCW/q+MWX93d1gcwdaz4fp7JIDKRvy012n66c3\nBSBVE0JedBFZgLclGj0dW2sXLz0+pHw+GE58vKfAMR5dB0Fot2U0yie9ho5++LDY\nTLbIGghFxDJsijXkTapgqdsHj9aG9kCaA4opMDVFlQnZiOAFkizGdPwUIRzUlAi5\ndNDDZ/t/6tQZeSUTM8eGCwIA27AHfNdkUQLyrVSof5qyNFi3BgFrh/Xf/2KHAWnN\nnTDa4trXKfTbdh/rk2Nkw0AqEfNMNZOTfvsdW56yFi1ZvK5HusaNj/eUCC0aiYBW\nGx/tNf0XUC0QWxMGPpcK/Tvfcu7zGVNduv80Sz8Z/jmf5uiH6FzgpC3sg0/f+/oQ\ncHRE1mjMSy1sytM6elHhssUOUYwckcBa4CWtP0cwwCVwzqm+YKolsnfLph0YGB5f\nIuQTdAcIVa2XkmQ07eUA/+2GobY5AEOOZdh+ToGjc46ComvWDnVX+gXlEwARAQAB\ntCRKYW1lcyBDb2xlIDxyZWxlYXNlQGZpcmVmbHktaWlpLm9yZz6JAlQEEwEIAD4W\nIQSp1r6GbO43dYVLH5aRDPK16LbMbgUCZhu1nwIbAwUJDTL0bgULCQgHAgYVCgkI\nCwIEFgIDAQIeAQIXgAAKCRCRDPK16LbMbqx8D/9n5gLEpocdmSSIFZ84PeKTQs4o\npd/3KVJunzrwWnvLLFgqnds2y8IZURyKmrLeLWG/ECCpQ3glUzwA/0AVYs8wKpAb\neYVBgcgOeW+oOdKpy874cEFcbtQRLYnLsdyqWKifWJz0dg5PPybzAk4mgxfOh2oD\ncN2IkTjMoMir2zmFhyiIy3eMKvcs1ybQxbd9/bayUcaGbSDIQEmdEDl5/h99mgFR\nIzbRzOxRfHzC/QeGRpn9i0+vxNNH01aJ8y7NpUWzCVK2HQIY2jVQiHLWvBZ9JoUv\n5Ujax0mgCsffBWixCve4Q3+zuwhATIXH40wT8iT5cVV1IuoC9/hxkd2vJCEuZ57t\nSjccNEDshYQ5sc8VXUuG36o1qVxcHd/CLoWl/LTlFMmYgzOFBLTNTOBIU1BOwIet\nXEZgnO4cdzIemM1/ZpndwL79sSDZQYm9cjptuK5ptaxBY2aqjtaLQIPA/bsme7VC\nFlsvztL25lmiLO/QoBW6mRb2LcJIJeiOmYC3XIzjW80pYdXEFOx+XR4Fotdtx9QY\nNadNRgTblfUW8tDYjSsPZexCZjJ5q+Bc3WgFe8gv4frquOMRhXSf/AWiwfnoctX6\nje7fJMA/Ygxo8utOZWGxTVySHqZa0mSimwlY8xWPndazA72aETRmFIowblTCWPcP\nmGTV48SbyxUZsoUF57kCDQRmG7WfARAAxhwrIPgY3l95t967SzwAWRKh0MEmhKtI\nY/QgkgcuIjFjZtA/CvBuK+OfAzNeSyU5jkIlkEhHjTvlW9ZHg7/qhYWhktZ2+lxW\nz2OxHlE92MnNWx5X4j6fxiZaR9RFvi1nBGlkl7BYdpTjqJEoh31QAxTXtVAU/KIG\ngTDyQjlg2sa4nCdIGu1BSW6JPUS3EicQC4eeExTmCkfbKYaC4wWsFz6awjGOTA9n\nSKfZiCR6AqvbKujaWGFJl/Vix6FKKKpPXsSNP6l0dFw0GL1oAd3roeV77D4MeW2T\npzA5BFLMlSMaOUn1SsjHOCVWk5xln1Cv7XP/vWWjxT7aJhLBtwUBBaMD5Wsc97Tt\nLJKk7B0GrUlKvjfg1GuyrpNhSiWdOHIKZed42koi6dwaKMzeiH3J3oNkQyTJSMWj\nkL6hpY7/ZTwyhTWa9DxriHJKvuuBz5hYZk98SoMgyiyS3Z1Gndg3xfAi++uvaSrU\ngA9vvBbkNupVIDcrJijt6iYZYE8u5+JwYDm2IaJkhaqmW/TN5SGZq3muW6DJC6dy\nrEMFnAu4ViVNE6X4fzAUK14yva8evZQ0ezuBw2Oe/FiOYKM2tIUb7upEVuSg3Ku0\ndYWeVAggE1JY0IznreNtHe6CZdTj9blxVzpz8Vff9HaWAeslsccgDqs6msvpPtU5\ntqtR0v0luIsAEQEAAYkCPAQYAQgAJhYhBKnWvoZs7jd1hUsflpEM8rXotsxuBQJm\nG7WfAhsMBQkNMvRuAAoJEJEM8rXotsxuxYoP/jeU6MzVpnOJETCG5L6Nhg61JiH1\nJky7fu+dcfadzNA3elaQKIwlsCPuBGnLuJrsN7tvDTzJueBOjZJhkQDr08XxaT7w\nT8mdxWnZyPMHyso+Shkmb+0DITjiYnPCoq6t6ZLv7jZnrdXFE3YZ74MUEqNR0rgU\n09q7OmfHRdAeCi5ow0bfmM2DaYru4nk9RKfgprYBbhamm8DSDz4oZdR7FNGtkuHs\nEVVticY/y0f4hQPk444rhGn6fV4rOsbMgWNS3lxNQMbQoJLzxNdEUYCdTb8j2CPK\nM9tR6GTeEXyGdB7m9BeLePfb8wzZP6x4yIRx7mys4hHDg0JN9FJo0efFRnYRWP5L\n9VVsqQTYOb6Qw268RVfuvEGEhqi5J9CyG5VOS4nj+7TQxd3+xAEipcxftIXJP+Ng\n0osEl4euoU19LwkjzC462OzrvXB1G/hakxzTyNO05GSe4PPXoY00SJFM5n4RDFBG\nJoEnE+CuxOI9bVF49ldiqGcdIBfSBNDx5V1930UzT5f4UPOWjqfM4fEfioQjXKae\n10buq8JbsmtQkuDHFHqYqL1CvVjIYio4UPvKSyp+JD08waiMJuFarb+RBHTqzm03\npAHD3dHArnDWzA7W3+kZ0Wpjd0IoepPSQvhee52eYH3NQfxv+5BNkviXlBlJ4FYU\nhjpKFilMeZp2wOQS\n=Hget\n-----END PGP PUBLIC KEY BLOCK-----\n\n```\n\n\n",
      "documentId": "explanation/more-information/signatures",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/more-information/signatures/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/more-information/signatures/index.md"
        }
      ]
    },
    {
      "id": "explanation/other-tools/index.md",
      "kind": "page",
      "title": "Other Firefly III related tools",
      "description": "There are a number of Firefly III tools and libraries you can check out and use, which are made by me.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/other-tools/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/other-tools/index.md",
      "file": "explanation/other-tools/index.md",
      "searchText": "\n# Other Firefly III related tools {#other-firefly-iii-related-tools}\n\n\nThere are a number of Firefly III tools and libraries you can check out and use, which are made by me.\n\nAlso interesting:\n\n- [Tools for the Data Importer made by other people](/references/data-importer/third-party-tools/)\n- [Firefly III apps and tools made by other people](/references/firefly-iii/third-parties/apps/)\n- [Places that host or platforms that can run Firefly III](/references/firefly-iii/third-parties/host/)\n\n\n## Product manager {#product-manager}\n\n\nThe [Firefly III product manager](https://github.com/JC5/product-manager) is a tool that you can use to manage costs over time, for example for your car or for your appliances.\n\n\n## Auto-save tool {#auto-save-tool}\n\n\nThe [Firefly III auto-save tool](https://github.com/JC5/autosave) is a tool that you can use to automatically create new \"top up\"-transactions that round your expenses up to the nearest Euro.\n\n\n## Libraries {#libraries}\n\n\n\n### API support classes {#api-support-classes}\n\n\nA [small package](https://github.com/JC5/api-support-classes) with code to use the Firefly III API. Is used in the data import tools.\n\n\n### Recovery code thing {#recovery-code-thing}\n\n\nA small change to [a recovery code package](https://github.com/JC5/recovery), so it's compatible with PHP %PHPVERSION.\n\n\n### 2FA laravel code things {#2fa-laravel-code-things}\n\n\nSome changes to [a 2FA package](https://github.com/JC5/google2fa-laravel), so it can handle 2FA authentication over sessions.\n\n\n### API docs {#api-docs}\n\n\nThe [Firefly III API docs](https://github.com/firefly-iii/api-docs) and [the underlying generator](https://github.com/firefly-iii/api-docs-generator).\n",
      "documentId": "explanation/other-tools",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/other-tools/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/other-tools/index.md"
        }
      ]
    },
    {
      "id": "explanation/code-of-conduct/index.md",
      "kind": "page",
      "title": "Contributor Covenant Code of Conduct",
      "description": "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, nationality, personal appearance, race, religion, or sexual identity and orientation.",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/code-of-conduct/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/code-of-conduct/index.md",
      "file": "explanation/code-of-conduct/index.md",
      "searchText": "\n# Contributor Covenant Code of Conduct {#contributor-covenant-code-of-conduct}\n\n\n\n## Our Pledge {#our-pledge}\n\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making\nparticipation in our project and our community a harassment-free experience for everyone, regardless of age, body size,\ndisability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,\nreligion, or sexual identity and orientation.\n\n\n## Our Standards {#our-standards}\n\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n\n## Our Responsibilities {#our-responsibilities}\n\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take\nappropriate and fair corrective action in response to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,\nissues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any\ncontributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n\n## Scope {#scope}\n\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the\nproject or its community. Examples of representing a project or community include using an official project e-mail\naddress, posting via an official social media account, or acting as an appointed representative at an online or offline\nevent. Representation of a project may be further defined and clarified by project maintainers.\n\n\n## Enforcement {#enforcement}\n\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at\njames@firefly-iii.org. The project team will review and investigate all complaints, and will respond in a way that it\ndeems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the\nreporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent\nrepercussions as determined by other members of the project's leadership.\n\n\n## Attribution {#attribution}\n\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\n\n[homepage]: http://contributor-covenant.org\n\n[version]: http://contributor-covenant.org/version/1/4/\n",
      "documentId": "explanation/code-of-conduct",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/code-of-conduct/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/code-of-conduct/index.md"
        }
      ]
    },
    {
      "id": "explanation/contributing/index.md",
      "kind": "page",
      "title": "Contributing to Firefly III",
      "description": "Thank you so much for wanting to help make Firefly III better!",
      "tab": "",
      "url": "https://sourcey-firefly.pages.dev/explanation/contributing/",
      "markdown": "https://sourcey-firefly.pages.dev/explanation/contributing/index.md",
      "file": "explanation/contributing/index.md",
      "searchText": "\n# Contributing to Firefly III {#contributing-to-firefly-iii}\n\n\nThank you so much for wanting to help make Firefly III better!\n\nPlease keep the following rules in mind, so we can both save a lot of time.\n\nFirst, please familiarize yourself with the [code of conduct](/explanation/code-of-conduct/), as it sets out general guidelines for interactions.\n\nPull requests for the `main` branch will be closed automatically.\n\n\n## What to be familiar with {#what-to-be-familiar-with}\n\n\nThis project is built using PHP8.5, Laravel, Twig, Javascript, HTML and CSS.\n\n\n## Fixing bugs {#fixing-bugs}\n\n\nIf you see a bug, and your first reaction is to open a PR, please describe the bug and its fix very carefully. When your fix requires a lot of changes, please let me know beforehand. I cannot accept new features out of the blue. Please first discuss the change you wish to make via issue, email, or any other method.\n\n\n## Listening and learning {#listening-and-learning}\n\n\nFor some people, getting a PR merged is like a badge of honor. Low effort PRs that fix spelling errors or change a single broken HTML tag will not be accepted. I'm afraid Firefly III can't be your learning experience. If you're new to all of this, please go be new somewhere else, thank you. Do not open PRs to \"discuss\" possible solutions or to \"get feedback\" on your code.\n\n\n## Code quality {#code-quality}\n\n\nHere are some guidelines to how I would like any set of commits to be. (I fully realize that I myself haven't always held myself to these standards, and there is a lot of code quality backfilling to be done.)\n\n\n### Documentability {#documentability}\n\n\nRather than leaving a TODO comment, open a new issue. The issue should be clear, contain some ideas about how things would be implemented, how it would fit in, what the requirements for completion of the issue is, and so on.\n\nAny new functionality must be reflected with a functional test that demonstrates it is working. Any new functionality should also come with updates to the appropriate sections of the [documentation](https://docs.firefly-iii.org).\n\nCode should attempt to be self-documenting, but should also be commented to explain what's going on, at least at a high level.\n\n\n### Performance and complexity {#performance-and-complexity}\n\n\nOne-liners or complex list/dict comprehensions are okay as long as they are clear and idiomatic. Please do not do nested comprehensions unless they are very simple and obvious; instead, split them out into separate, clear steps.\n\nAny performance-optimization work should be done based on where optimization is needed, and it must show an actual measurable improvement. (Optimizing the clarity of code, on the other hand, is always welcome!)\n\n\n### Avoiding \"unitaskers\" {#avoiding-unitaskers}\n\n\nFunctionality should only be added if it would potentially benefit everyone. With this in mind, any functionality that does only one specific thing should be made at least flexible or extensible enough that it can also do other, related things.\n\nThe API should be small and consistent and easy for anyone to use, or be easy for anyone to know where to look to understand something.\n\n\n### Test coverage {#test-coverage}\n\n\nAll new code should be tested in some way. Ideally this would be in the form of unit tests, but the reality is that much of Firefly III's functionality is difficult to unit test. All things should at least be manually tested with a repeatable procedure, and any tests for page-rendering functionality should be added into the local test site.\n\n\n### No AI contributions {#no-ai-contributions}\n\n\nThis software is made by people, for people. While limited uses of AI can be helpful, the direct use of AI-generated code is an ethical and legal minefield. The current means by which models are trained puts an undue burden on the people, systems, and resources who are being exploited with vanishingly small returns on their efforts. Further, AI code is not generated with the context of the specific needs or design goals of a project.\n\nContributing to Firefly III requires human judgment, contextual understanding, and familiarity with Firefly III's structure and goals. It is not suitable for automatic processing by AI tools.\n\n- Refrain from submitting issues, pull requests or security advisories generated by any automated tools. I reserve the right, at my sole discretion, to close such submissions and to block any account responsible for them. \n- Do not paste AI generated text in the description of issues, PRs or in comments as this makes it harder for reviewers to assess your contribution. We are happy for it to be used to improve grammar or if you are not a native English speaker.\n\n\n## Behavior {#behavior}\n\n\nBe prepared to answer whatever questions people might have about a contribution. Assume all questions are being made in good faith, and respond in kind.\n\nThe same goes for issues.\n\n\n## License {#license}\n\n\nYour code will be licensed under [the current Firefly III license](https://github.com/firefly-iii/firefly-iii/blob/main/LICENSE). There are no exceptions, and you must be the sole writer of the code you submit. See also the earlier section titled \"NO AI contributions.\"\n\nFirefly III is a passion project, and I am only accepting submissions from people who are as passionate as me about this application. Your drive-by resume-filling PR will not be accepted.\n\n\n## Developer certificate of origin {#developer-certificate-of-origin}\n\n\nPlease read [the developer certificate of origin](https://developercertificate.org/) and agree and comply with it.\n\n\n\n## Contributing text and documentation {#contributing-text-and-documentation}\n\n\nIf you see a spelling error, grammatical error or a weird translation *in your language*, please join [our CrowdIn](https://crowdin.com/project/firefly-iii) project. There, you can submit your translations and fixes. The GitHub repository will download these automatically, and they will be included in the next release.\n\nKnow that I am always open for rewrites and more clarity in the documentation, but I will not accept changes that people can Google themselves already. For example, do not submit text that explains how to set up Docker. Or how to install PHP.\n\nAny documentation you write or fix must be checked for correct spelling. If you correct my spelling or grammar, you don't make mistakes of your own.\n\nIs your language not listed? You can send your language [to me by email](mailto:james@firefly-iii.org) or [open a ticket on GitHub](https://github.com/firefly-iii/firefly-iii/issues).\n\nThis guideline was inspired by the excellent [Publ contribution policy](https://github.com/PlaidWeb/Publ/blob/bcf6d798cf58ee9880bd406fd7686026824d42e2/CONTRIBUTING.md) and the [contributing guidelines of the scikit-learn project](https://scikit-learn.org/stable/developers/contributing.html#automated-contributions-policy).\n",
      "documentId": "explanation/contributing",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/explanation/contributing/",
          "markdown": "https://sourcey-firefly.pages.dev/explanation/contributing/index.md"
        }
      ]
    },
    {
      "id": "api/index.md",
      "kind": "page",
      "title": "Firefly III API",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/",
      "markdown": "https://sourcey-firefly.pages.dev/api/index.md",
      "file": "api/index.md",
      "searchText": "info title Firefly III API summary  version v6.7.8 description 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](/how-to/firefly-iii/features/api/) shows how to create the OAuth client or Personal Access Token they need, and the [API reference guide](/references/firefly-iii/api/) explains the currency fields, configuration values and webhooks.\n\nPlease keep in mind that the demo site does **not** accept requests from `curl`, `colly`, `wget`, etc. You must use a browser or a tool like Insomnia to make your test requests.\n\nPlease report any bugs or issues on [GitHub](https://github.com/firefly-iii/firefly-iii/issues). This file was last generated on 2026-10-19 @ 07:39:02 (Europe/Amsterdam).\n termsOfService  contact name James Cole url https://firefly-iii.org email james@firefly-iii.org license name AGPLv3 url https://www.gnu.org/licenses/agpl-3.0.en.html identifier  logo  servers 0 url https://{installation}/api description Your Firefly III installation variables installation default firefly.example.com description Your installation's host. enum  1 url https://demo.firefly-iii.org/api description Firefly III demo site (refuses command-line clients) variables  tags 0 name about summary System description These endpoints deliver general system information, version- and meta information. externalDocs  1 name configuration summary Configuration description These endpoints allow you to manage and update the Firefly III configuration. You need to have the \"owner\" role to update configuration. externalDocs  2 name accounts summary Accounts description Endpoints that deliver all of the user's asset, expense and other accounts (and the metadata) together with related transactions, piggy banks and other objects. Also delivers endpoints for CRUD operations for accounts. externalDocs  3 name piggy_banks summary Piggy banks description Endpoints to control and manage all of the user's piggy banks and related objects and information. externalDocs  4 name transactions summary Transactions description The most-used endpoints in Firefly III, these endpoints are used to manage the user's transactions. externalDocs  5 name links summary Transaction links description Endpoints to manage links between transactions, and manage the type of links available. externalDocs  6 name attachments summary Attachments description Endpoints to manage the attachments of the authenticated user, including up- and downloading of the files. externalDocs  7 name budgets summary Budgets description Endpoints to manage a user's budgets and get info on the related objects, like limits. externalDocs  8 name available_budgets summary Available budgets description Endpoints to manage the total available amount that the user has made available to themselves. Used in periodic budgeting. externalDocs  9 name bills summary Subscriptions description Endpoints to manage a user's bills and all related objects. externalDocs  10 name recurrences summary Recurring transactions description Use these endpoints to manage the user's recurring transactions, trigger the creation of transactions and manage the settings. externalDocs  11 name categories summary Categories description Endpoints to manage a user's categories and get information on transactions and other related objects. externalDocs  12 name tags summary Tags description This endpoint manages all of the user's tags. externalDocs  13 name object_groups summary Object groups description Endpoints to control and manage all of the user's object groups. Can only be created in conjunction with another object (for example a piggy bank) and will auto-delete when no other items are linked to it. externalDocs  14 name currencies summary Currencies description Endpoints to manage the currencies in Firefly III. Depending on the user's role you can also disable and enable them, or add new ones. externalDocs  15 name currency_exchange_rates summary Exchange rates description All currency exchange rates. externalDocs  16 name rules summary Rules description These endpoints can be used to manage all of the user's rules. Also includes triggers to execute or test rules and individual triggers. externalDocs  17 name rule_groups summary Rule groups description Manage all of the user's groups of rules and trigger the execution of entire groups. externalDocs  18 name webhooks summary Webhooks description These endpoints can be used to manage the user's webhooks and triggers them if necessary. externalDocs  19 name insight summary Insight description The \"insight\" endpoints try to deliver sums, balances and insightful information in the broadest sense of the word. externalDocs  20 name summary summary Summary description These endpoints deliver summaries, like sums, lists of numbers and other processed information. Mainly used for the main dashboard and pretty specific for Firefly III itself. externalDocs  21 name charts summary Charts description The \"charts\" endpoints deliver optimised data for charts and graphs. externalDocs  22 name search summary Search description Endpoints that allow you to search through the user's financial data. Different from the autocomplete endpoints, the search accepts more advanced arguments. externalDocs  23 name autocomplete summary Autocomplete description Auto-complete endpoints show basic information about Firefly III models, like the name and maybe some amounts. They all support a search query and can be used to autocomplete data in forms. Autocomplete return values always have a \"name\"-field. externalDocs  24 name data summary Data description The \"data\"-endpoints manage generic Firefly III and user-specific data. externalDocs  25 name preferences summary Preferences description These endpoints can be used to manage the user's preferences, including some hidden ones. externalDocs  26 name user_groups summary Financial administrations description User groups are the objects around which \"financial administrations\" are built. externalDocs  27 name users summary Users description Use these endpoints to manage the users registered within Firefly III. You need to have the \"owner\" role to access these endpoints. externalDocs  securitySchemes firefly_iii_auth type oauth2 name  description OAuth2 authorization code flow. Create a client on your installation's `/profile` page; it authorizes at `/oauth/authorize` and issues tokens at `/oauth/token` there. The URLs below are the demo site's. [How to use the API](/how-to/firefly-iii/features/api/) walks through it. in  scheme  bearerFormat  flows authorizationCode authorizationUrl https://demo.firefly-iii.org/oauth/authorize deviceAuthorizationUrl  tokenUrl https://demo.firefly-iii.org/oauth/token refreshUrl https://demo.firefly-iii.org/oauth/token scopes  openIdConnectUrl  oauth2MetadataUrl  deprecated  local_bearer_auth type http name  description A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens. in  scheme bearer bearerFormat  flows  openIdConnectUrl  oauth2MetadataUrl  deprecated ",
      "documentId": "introduction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/",
          "markdown": "https://sourcey-firefly.pages.dev/api/index.md"
        }
      ]
    },
    {
      "id": "api/getaccountsac/index.md",
      "kind": "operation",
      "title": "Returns all accounts of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/accounts: returns AutocompleteAccountArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getaccountsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getaccountsac/index.md",
      "file": "api/getaccountsac/index.md",
      "searchText": "operationId getAccountsAC summary Returns all accounts of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/accounts tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  3 name date in query description If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date in the AC title. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 2026-10-01 examples  4 name types in query description Optional filter on the account type(s) used in the autocomplete. required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description  default  enum 0 all 1 asset 2 cash 3 expense 4 revenue 5 special 6 hidden 7 liability 8 liabilities 9 Default account 10 Cash account 11 Asset account 12 Expense account 13 Revenue account 14 Initial balance account 15 Beneficiary account 16 Import account 17 Reconciliation account 18 Loan 19 Debt 20 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of accounts with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteAccountArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteAccount properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the account found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account examples  refName  name_with_balance name  type string format string title  description Asset accounts and liabilities have a second field with the given date's account balance in the account currency or primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account ($123.45) examples  refName  active name  type boolean format  title  description Is the account active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type string format string title  description Account type of the account found by the auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName  currency_id name  type string format string title  description ID for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_name name  type string format string title  description Currency name for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_id name  type string format string title  description ID for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency ID is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_name name  type string format string title  description Name for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency name is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example US Dollar examples  refName  account_currency_code name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  account_currency_symbol name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  account_currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 name_with_balance 3 active 4 type 5 currency_id 6 currency_name 7 currency_code 8 currency_symbol 9 currency_decimal_places 10 account_currency_id 11 account_currency_name 12 account_currency_code 13 account_currency_symbol 14 account_currency_decimal_places example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getaccountsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getaccountsac/index.md"
        }
      ]
    },
    {
      "id": "api/getbillsac/index.md",
      "kind": "operation",
      "title": "Returns all bills of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/bills: returns AutocompleteBillArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbillsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbillsac/index.md",
      "file": "api/getbillsac/index.md",
      "searchText": "operationId getBillsAC summary Returns all bills of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/bills tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of bills with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBillArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBill properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the bill found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbillsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbillsac/index.md"
        }
      ]
    },
    {
      "id": "api/getbudgetsac/index.md",
      "kind": "operation",
      "title": "Returns all budgets of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/budgets: returns AutocompleteBudgetArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbudgetsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbudgetsac/index.md",
      "file": "api/getbudgetsac/index.md",
      "searchText": "operationId getBudgetsAC summary Returns all budgets of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/budgets tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of budgets with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBudgetArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBudget properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the budget found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  active name  type boolean format  title  description Is the budget active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbudgetsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbudgetsac/index.md"
        }
      ]
    },
    {
      "id": "api/getcategoriesac/index.md",
      "kind": "operation",
      "title": "Returns all categories of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/categories: returns AutocompleteCategoryArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcategoriesac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcategoriesac/index.md",
      "file": "api/getcategoriesac/index.md",
      "searchText": "operationId getCategoriesAC summary Returns all categories of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/categories tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of categories with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCategoryArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCategory properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the category found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Category X examples  refName  required 0 id 1 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/categories",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcategoriesac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcategoriesac/index.md"
        }
      ]
    },
    {
      "id": "api/getcurrenciesac/index.md",
      "kind": "operation",
      "title": "Returns all currencies of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/currencies: returns AutocompleteCurrencyArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcurrenciesac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcurrenciesac/index.md",
      "file": "api/getcurrenciesac/index.md",
      "searchText": "operationId getCurrenciesAC summary Returns all currencies of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/currencies tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of currencies with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrencyArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrency properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Currency name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Currency name examples  refName  code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 code 3 symbol 4 decimal_places example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcurrenciesac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcurrenciesac/index.md"
        }
      ]
    },
    {
      "id": "api/getobjectgroupsac/index.md",
      "kind": "operation",
      "title": "Returns all object groups of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/object-groups: returns AutocompleteObjectGroupArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getobjectgroupsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getobjectgroupsac/index.md",
      "file": "api/getobjectgroupsac/index.md",
      "searchText": "operationId getObjectGroupsAC summary Returns all object groups of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/object-groups tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of object groups with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteObjectGroupArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteObjectGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  title name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  required 0 id 1 title 2 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/object-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getobjectgroupsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getobjectgroupsac/index.md"
        }
      ]
    },
    {
      "id": "api/getpiggiesac/index.md",
      "kind": "operation",
      "title": "Returns all piggy banks of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/piggy-banks: returns AutocompletePiggyBalanceArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getpiggiesac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getpiggiesac/index.md",
      "file": "api/getpiggiesac/index.md",
      "searchText": "operationId getPiggiesAC summary Returns all piggy banks of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/piggy-banks tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy banks with basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggyBalanceArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggyBalance properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the piggy bank found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch examples  refName  name_with_balance name  type string format string title  description Name of the piggy bank found by an auto-complete search, including the currently saved amount and the target amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch ($234.56 / $600) examples  refName  currency_id name  type string format string title  description Currency ID for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Currency decimal places for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 id 1 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getpiggiesac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getpiggiesac/index.md"
        }
      ]
    },
    {
      "id": "api/getrecurringac/index.md",
      "kind": "operation",
      "title": "Returns all recurring transactions of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/recurring: returns AutocompleteRecurrenceArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrecurringac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrecurringac/index.md",
      "file": "api/getrecurringac/index.md",
      "searchText": "operationId getRecurringAC summary Returns all recurring transactions of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/recurring tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of recurring transactions with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRecurrenceArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRecurrence properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the recurrence found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  description name  type string format string title  description Description of the recurrence found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Should trigger daily. examples  refName  active name  type boolean format  title  description Is the recurring transaction active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/recurring",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrecurringac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrecurringac/index.md"
        }
      ]
    },
    {
      "id": "api/getrulegroupsac/index.md",
      "kind": "operation",
      "title": "Returns all rule groups of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/rule-groups: returns AutocompleteRuleGroupArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrulegroupsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrulegroupsac/index.md",
      "file": "api/getrulegroupsac/index.md",
      "searchText": "operationId getRuleGroupsAC summary Returns all rule groups of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/rule-groups tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of rule groups with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleGroupArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule group one examples  refName  description name  type string format string title  description Description of the rule group found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some rule group. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/rule-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrulegroupsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrulegroupsac/index.md"
        }
      ]
    },
    {
      "id": "api/getrulesac/index.md",
      "kind": "operation",
      "title": "Returns all rules of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/rules: returns AutocompleteRuleArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrulesac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrulesac/index.md",
      "file": "api/getrulesac/index.md",
      "searchText": "operationId getRulesAC summary Returns all rules of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/rules tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of rules with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRule properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule one examples  refName  description name  type string format string title  description Description of the rule found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Useful rule. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrulesac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrulesac/index.md"
        }
      ]
    },
    {
      "id": "api/getsubscriptionsac/index.md",
      "kind": "operation",
      "title": "Returns all subscriptions of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/subscriptions: returns AutocompleteBillArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getsubscriptionsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getsubscriptionsac/index.md",
      "file": "api/getsubscriptionsac/index.md",
      "searchText": "operationId getSubscriptionsAC summary Returns all subscriptions of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/subscriptions tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of subscriptions with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBillArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBill properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the bill found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getsubscriptionsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getsubscriptionsac/index.md"
        }
      ]
    },
    {
      "id": "api/gettagac/index.md",
      "kind": "operation",
      "title": "Returns all tags of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/tags: returns AutocompleteTagArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettagac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettagac/index.md",
      "file": "api/gettagac/index.md",
      "searchText": "operationId getTagAC summary Returns all tags of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/tags tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of tags with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTagArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTag properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  tag name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  required 0 id 1 name 2 tag example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/tags",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettagac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettagac/index.md"
        }
      ]
    },
    {
      "id": "api/gettransactiontypesac/index.md",
      "kind": "operation",
      "title": "Returns all transaction types returned in a basic auto-complete array. English only.",
      "description": "GET /v1/autocomplete/transaction-types: returns AutocompleteTransactionTypeArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransactiontypesac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransactiontypesac/index.md",
      "file": "api/gettransactiontypesac/index.md",
      "searchText": "operationId getTransactionTypesAC summary Returns all transaction types returned in a basic auto-complete array. English only. description  method get path /v1/autocomplete/transaction-types tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of transaction types with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionTypeArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionType properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Type of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  type name  type string format string title  description Name of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  required 0 id 1 name 2 type example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/transaction-types",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransactiontypesac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransactiontypesac/index.md"
        }
      ]
    },
    {
      "id": "api/gettransactionsac/index.md",
      "kind": "operation",
      "title": "Returns all transaction descriptions of the user returned in a basic auto-complete array.",
      "description": "GET /v1/autocomplete/transactions: returns AutocompleteTransactionArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransactionsac/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionsac/index.md",
      "file": "api/gettransactionsac/index.md",
      "searchText": "operationId getTransactionsAC summary Returns all transaction descriptions of the user returned in a basic auto-complete array. description  method get path /v1/autocomplete/transactions tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description A list of transaction descriptions with very basic information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransaction properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  description name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  required 0 id 1 name 2 description example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransactionsac/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionsac/index.md"
        }
      ]
    },
    {
      "id": "api/gettransactionswithmeta/index.md",
      "kind": "operation",
      "title": "Returns all transactions, complemented with meta information.",
      "description": "GET /v1/autocomplete/transactions-with-meta: returns AutocompleteTransactionWithMetaArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransactionswithmeta/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionswithmeta/index.md",
      "file": "api/gettransactionswithmeta/index.md",
      "searchText": "operationId getTransactionsWithMeta summary Returns all transactions, complemented with meta information. description  method get path /v1/autocomplete/transactions-with-meta tags 0 autocomplete parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The autocomplete search query. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example string examples  2 name limit in query description The number of items returned. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 10 examples  requestBody  responses 0 statusCode 200 summary  description Returns all transactions, complemented with meta information. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionWithMetaArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionWithMeta properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  description name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  currency_code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id 1 name 2 description example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/autocomplete/transactions-with-meta",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransactionswithmeta/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionswithmeta/index.md"
        }
      ]
    },
    {
      "id": "api/getchartaccountoverview/index.md",
      "kind": "operation",
      "title": "Dashboard chart with asset account balance information.",
      "description": "This endpoint returns the data required to generate a chart with basic asset account balance information. This is used on the dashboard.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getchartaccountoverview/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getchartaccountoverview/index.md",
      "file": "api/getchartaccountoverview/index.md",
      "searchText": "operationId getChartAccountOverview summary Dashboard chart with asset account balance information. description This endpoint returns the data required to generate a chart with basic asset account balance information. This is used on the dashboard.\n method get path /v1/chart/account/overview tags 0 charts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name period in query description Optional period to group the data by. If not provided, it will default to '1M' or whatever is deemed relevant for the range provided.\n\nIf you want to know which periods are available, see the enums or get the configuration value: `GET /api/v1/configuration/firefly.valid_view_ranges`\n required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 1D 1 1W 2 1M 3 3M 4 6M 5 1Y enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName  content  example  examples  4 name preselected in query description Optional set of preselected accounts to limit the chart to. This may be easier than submitting all asset accounts manually, for example.\nIf you want to know which selection are available, see the enums here or get the configuration value: `GET /api/v1/configuration/firefly.preselected_accounts`\n\n- `empty`: do not do a pre-selection\n- `all`: select all asset and all liability accounts\n- `assets`: select all asset accounts\n- `liabilities`: select all liability accounts\n\nIf no accounts are found, the user's \"frontpage accounts\" preference will be used. If that is empty, all asset accounts will be used.\n required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 empty 1 all 2 assets 3 liabilities enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example all examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/chart/account/overview",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getchartaccountoverview/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getchartaccountoverview/index.md"
        }
      ]
    },
    {
      "id": "api/getchartbalance/index.md",
      "kind": "operation",
      "title": "Dashboard chart with balance information.",
      "description": "This endpoint returns the data required to generate a chart with balance information.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getchartbalance/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getchartbalance/index.md",
      "file": "api/getchartbalance/index.md",
      "searchText": "operationId getChartBalance summary Dashboard chart with balance information. description This endpoint returns the data required to generate a chart with balance information.\n method get path /v1/chart/balance/balance tags 0 charts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name period in query description Optional period to group the data by. If not provided, it will default to '1M' or whatever is deemed relevant for the range provided.\n\nIf you want to know which periods are available, see the enums or get the configuration value: `GET /api/v1/configuration/firefly.valid_view_ranges`\n required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 1D 1 1W 2 1M 3 3M 4 6M 5 1Y enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName  content  example  examples  4 name preselected in query description Optional set of preselected accounts to limit the chart to. This may be easier than submitting all asset accounts manually, for example.\nIf you want to know which selection are available, see the enums here or get the configuration value: `GET /api/v1/configuration/firefly.preselected_accounts`\n\n- `empty`: do not do a pre-selection\n- `all`: select all asset and all liability accounts\n- `assets`: select all asset accounts\n- `liabilities`: select all liability accounts\n\nIf no accounts are found, the user's \"frontpage accounts\" preference will be used. If that is empty, all asset accounts will be used.\n required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 empty 1 all 2 assets 3 liabilities enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example all examples  refName  content  example  examples  5 name accounts[] in query description Limit the chart to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.\n\nThis list of accounts will be OVERRULED by the `preselected` parameter.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/chart/balance/balance",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getchartbalance/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getchartbalance/index.md"
        }
      ]
    },
    {
      "id": "api/getchartbudgetoverview/index.md",
      "kind": "operation",
      "title": "Dashboard chart with budget information.",
      "description": "This endpoint returns the data required to generate a chart with basic budget information.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverview/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverview/index.md",
      "file": "api/getchartbudgetoverview/index.md",
      "searchText": "operationId getChartBudgetOverview summary Dashboard chart with budget information. description This endpoint returns the data required to generate a chart with basic budget information.\n method get path /v1/chart/budget/overview tags 0 charts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description Bar chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/chart/budget/overview",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverview/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverview/index.md"
        }
      ]
    },
    {
      "id": "api/getchartbudgetoverviewwithlimits/index.md",
      "kind": "operation",
      "title": "Dashboard chart with budget and budget limit information.",
      "description": "This endpoint returns the data required to generate a chart with basic budget information, grouped by budget limit when necessary.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverviewwithlimits/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverviewwithlimits/index.md",
      "file": "api/getchartbudgetoverviewwithlimits/index.md",
      "searchText": "operationId getChartBudgetOverviewWithLimits summary Dashboard chart with budget and budget limit information. description This endpoint returns the data required to generate a chart with basic budget information, grouped by budget limit when necessary.\n method get path /v1/chart/budget/overview-with-limits tags 0 charts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description Bar chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/chart/budget/overview-with-limits",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverviewwithlimits/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getchartbudgetoverviewwithlimits/index.md"
        }
      ]
    },
    {
      "id": "api/getchartcategoryoverview/index.md",
      "kind": "operation",
      "title": "Dashboard chart with category information.",
      "description": "This endpoint returns the data required to generate a chart with basic category information.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getchartcategoryoverview/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getchartcategoryoverview/index.md",
      "file": "api/getchartcategoryoverview/index.md",
      "searchText": "operationId getChartCategoryOverview summary Dashboard chart with category information. description This endpoint returns the data required to generate a chart with basic category information.\n method get path /v1/chart/category/overview tags 0 charts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/chart/category/overview",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getchartcategoryoverview/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getchartcategoryoverview/index.md"
        }
      ]
    },
    {
      "id": "api/bulkupdatetransactions/index.md",
      "kind": "operation",
      "title": "Bulk update transaction properties",
      "description": "Allows you to update transactions in bulk. For more information, see Bulk transaction update.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/bulkupdatetransactions/",
      "markdown": "https://sourcey-firefly.pages.dev/api/bulkupdatetransactions/index.md",
      "file": "api/bulkupdatetransactions/index.md",
      "searchText": "operationId bulkUpdateTransactions summary Bulk update transaction properties description Allows you to update transactions in bulk. For more information, see [Bulk transaction update](/references/firefly-iii/api/specials/#bulk-transaction-update).\n method post path /v1/data/bulk/transactions tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name query in query description The JSON query. required  deprecated  style  explode  allowReserved  schema name  type string format json title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Empty response when the update was successful. A future improvement is to include the changed transactions. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/data/bulk/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/bulkupdatetransactions/",
          "markdown": "https://sourcey-firefly.pages.dev/api/bulkupdatetransactions/index.md"
        }
      ]
    },
    {
      "id": "api/destroydata/index.md",
      "kind": "operation",
      "title": "Endpoint to destroy user data",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/destroydata/",
      "markdown": "https://sourcey-firefly.pages.dev/api/destroydata/index.md",
      "file": "api/destroydata/index.md",
      "searchText": "operationId destroyData summary Endpoint to destroy user data description A call to this endpoint deletes the requested data type. Use it with care and always with user permission.\nThe demo user is incapable of using this endpoint.\n method delete path /v1/data/destroy tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name objects in query description The type of data that you wish to destroy. You can only use one at a time. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 not_assets_liabilities 1 budgets 2 bills 3 piggy_banks 4 rules 5 recurring 6 categories 7 tags 8 object_groups 9 accounts 10 asset_accounts 11 expense_accounts 12 revenue_accounts 13 liabilities 14 transactions 15 withdrawals 16 deposits 17 transfers enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName DataDestroyObject content  example  examples  2 name unused in query description Only applies when \"objects\" is set to: not_assets_liabilities, accounts, asset_accounts, expense_accounts, revenue_accounts or liabilities.\n\nIf set to true, only unused accounts will be destroyed. This effectively cleans up the autocomplete dropdowns.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Empty response when data has been destroyed. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/data/destroy",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/destroydata/",
          "markdown": "https://sourcey-firefly.pages.dev/api/destroydata/index.md"
        }
      ]
    },
    {
      "id": "api/exportaccounts/index.md",
      "kind": "operation",
      "title": "Export account data from Firefly III",
      "description": "This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportaccounts/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportaccounts/index.md",
      "file": "api/exportaccounts/index.md",
      "searchText": "operationId exportAccounts summary Export account data from Firefly III description This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/accounts tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportaccounts/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportaccounts/index.md"
        }
      ]
    },
    {
      "id": "api/exportbills/index.md",
      "kind": "operation",
      "title": "Export bills from Firefly III",
      "description": "This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportbills/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportbills/index.md",
      "file": "api/exportbills/index.md",
      "searchText": "operationId exportBills summary Export bills from Firefly III description This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/bills tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportbills/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportbills/index.md"
        }
      ]
    },
    {
      "id": "api/exportsubscriptions/index.md",
      "kind": "operation",
      "title": "Export subscriptions from Firefly III",
      "description": "This endpoint allows you to export your subscriptions (also known as bills) from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportsubscriptions/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportsubscriptions/index.md",
      "file": "api/exportsubscriptions/index.md",
      "searchText": "operationId exportSubscriptions summary Export subscriptions from Firefly III description This endpoint allows you to export your subscriptions (also known as bills) from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/subscriptions tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportsubscriptions/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportsubscriptions/index.md"
        }
      ]
    },
    {
      "id": "api/exportbudgets/index.md",
      "kind": "operation",
      "title": "Export budgets and budget amount data from Firefly III",
      "description": "This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportbudgets/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportbudgets/index.md",
      "file": "api/exportbudgets/index.md",
      "searchText": "operationId exportBudgets summary Export budgets and budget amount data from Firefly III description This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/budgets tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportbudgets/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportbudgets/index.md"
        }
      ]
    },
    {
      "id": "api/exportcategories/index.md",
      "kind": "operation",
      "title": "Export category data from Firefly III",
      "description": "This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportcategories/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportcategories/index.md",
      "file": "api/exportcategories/index.md",
      "searchText": "operationId exportCategories summary Export category data from Firefly III description This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/categories tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/categories",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportcategories/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportcategories/index.md"
        }
      ]
    },
    {
      "id": "api/exportpiggies/index.md",
      "kind": "operation",
      "title": "Export piggy banks from Firefly III",
      "description": "This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportpiggies/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportpiggies/index.md",
      "file": "api/exportpiggies/index.md",
      "searchText": "operationId exportPiggies summary Export piggy banks from Firefly III description This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/piggy-banks tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportpiggies/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportpiggies/index.md"
        }
      ]
    },
    {
      "id": "api/exportrecurring/index.md",
      "kind": "operation",
      "title": "Export recurring transaction data from Firefly III",
      "description": "This endpoint allows you to export your recurring transactions from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportrecurring/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportrecurring/index.md",
      "file": "api/exportrecurring/index.md",
      "searchText": "operationId exportRecurring summary Export recurring transaction data from Firefly III description This endpoint allows you to export your recurring transactions from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/recurring tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/recurring",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportrecurring/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportrecurring/index.md"
        }
      ]
    },
    {
      "id": "api/exportrules/index.md",
      "kind": "operation",
      "title": "Export rule groups and rule data from Firefly III",
      "description": "This endpoint allows you to export your rules and rule groups from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exportrules/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exportrules/index.md",
      "file": "api/exportrules/index.md",
      "searchText": "operationId exportRules summary Export rule groups and rule data from Firefly III description This endpoint allows you to export your rules and rule groups from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/rules tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exportrules/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exportrules/index.md"
        }
      ]
    },
    {
      "id": "api/exporttags/index.md",
      "kind": "operation",
      "title": "Export tag data from Firefly III",
      "description": "This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exporttags/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exporttags/index.md",
      "file": "api/exporttags/index.md",
      "searchText": "operationId exportTags summary Export tag data from Firefly III description This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/tags tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/tags",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exporttags/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exporttags/index.md"
        }
      ]
    },
    {
      "id": "api/exporttransactions/index.md",
      "kind": "operation",
      "title": "Export transaction data from Firefly III",
      "description": "This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/exporttransactions/",
      "markdown": "https://sourcey-firefly.pages.dev/api/exporttransactions/index.md",
      "file": "api/exporttransactions/index.md",
      "searchText": "operationId exportTransactions summary Export transaction data from Firefly III description This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only.\n method get path /v1/data/export/transactions tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts in query description Limit the export of transactions to these accounts only. Only asset accounts will be accepted. Other types will be silently dropped.\n required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 1,2,3 examples  4 name type in query description The file type the export file (CSV is currently the only option). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exported transaction in a file. content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/data/export/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/exporttransactions/",
          "markdown": "https://sourcey-firefly.pages.dev/api/exporttransactions/index.md"
        }
      ]
    },
    {
      "id": "api/purgedata/index.md",
      "kind": "operation",
      "title": "Endpoint to purge user data",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/purgedata/",
      "markdown": "https://sourcey-firefly.pages.dev/api/purgedata/index.md",
      "file": "api/purgedata/index.md",
      "searchText": "operationId purgeData summary Endpoint to purge user data description A call to this endpoint purges all previously deleted data. Use it with care and always with user permission.\nThe demo user is incapable of using this endpoint.\n method delete path /v1/data/purge tags 0 data parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 204 summary  description Empty response when data has been purged. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/data/purge",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/purgedata/",
          "markdown": "https://sourcey-firefly.pages.dev/api/purgedata/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpenseexpense/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by expense account.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by expense account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpenseexpense/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpenseexpense/index.md",
      "file": "api/insightexpenseexpense/index.md",
      "searchText": "operationId insightExpenseExpense summary Insight into expenses, grouped by expense account. description This endpoint gives a summary of the expenses made by the user, grouped by expense account.\n method get path /v1/insight/expense/expense tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you add the accounts ID's of expense accounts, only those accounts\nare included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. You can combine both asset / liability and expense account ID's.\nOther account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of expense accounts and expense details. Each expense account has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/expense",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpenseexpense/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpenseexpense/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpenseasset/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by asset account.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by asset account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpenseasset/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpenseasset/index.md",
      "file": "api/insightexpenseasset/index.md",
      "searchText": "operationId insightExpenseAsset summary Insight into expenses, grouped by asset account. description This endpoint gives a summary of the expenses made by the user, grouped by asset account.\n method get path /v1/insight/expense/asset tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of asset accounts and expense details. Each asset account has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/asset",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpenseasset/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpenseasset/index.md"
        }
      ]
    },
    {
      "id": "api/insightincomerevenue/index.md",
      "kind": "operation",
      "title": "Insight into income, grouped by revenue account.",
      "description": "This endpoint gives a summary of the income received by the user, grouped by revenue account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincomerevenue/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincomerevenue/index.md",
      "file": "api/insightincomerevenue/index.md",
      "searchText": "operationId insightIncomeRevenue summary Insight into income, grouped by revenue account. description This endpoint gives a summary of the income received by the user, grouped by revenue account.\n method get path /v1/insight/income/revenue tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you add the accounts ID's of revenue accounts, only those accounts\nare included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. You can combine both asset / liability and deposit account ID's.\nOther account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of revenue accounts and income details. Each revenue account has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/revenue",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincomerevenue/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincomerevenue/index.md"
        }
      ]
    },
    {
      "id": "api/insightincomeasset/index.md",
      "kind": "operation",
      "title": "Insight into income, grouped by asset account.",
      "description": "This endpoint gives a summary of the income received by the user, grouped by asset account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincomeasset/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincomeasset/index.md",
      "file": "api/insightincomeasset/index.md",
      "searchText": "operationId insightIncomeAsset summary Insight into income, grouped by asset account. description This endpoint gives a summary of the income received by the user, grouped by asset account.\n method get path /v1/insight/income/asset tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of asset accounts and income details. Each asset account has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/asset",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincomeasset/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincomeasset/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfers/index.md",
      "kind": "operation",
      "title": "Insight into transfers, grouped by account.",
      "description": "This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfers/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfers/index.md",
      "file": "api/insighttransfers/index.md",
      "searchText": "operationId insightTransfers summary Insight into transfers, grouped by account. description This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability.\n method get path /v1/insight/transfer/asset tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of asset accounts and transfer details. Each asset account has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTransfer items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTransferEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The total amount transferred between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  in name  type string format string title  description The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  in_float name  type number format double title  description The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out name  type string format string title  description The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out_float name  type number format double title  description The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/asset",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfers/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfers/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensebill/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by bill.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) bill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensebill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensebill/index.md",
      "file": "api/insightexpensebill/index.md",
      "searchText": "operationId insightExpenseBill summary Insight into expenses, grouped by bill. description This endpoint gives a summary of the expenses made by the user, grouped by (any) bill.\n method get path /v1/insight/expense/bill tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name bills[] in query description The bills to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budget and expense details. Each budget has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/bill",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensebill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensebill/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensenobill/index.md",
      "kind": "operation",
      "title": "Insight into expenses, without bill.",
      "description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no bill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensenobill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenobill/index.md",
      "file": "api/insightexpensenobill/index.md",
      "searchText": "operationId insightExpenseNoBill summary Insight into expenses, without bill. description This endpoint gives a summary of the expenses made by the user, including only expenses with no bill.\n method get path /v1/insight/expense/no-bill tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of expense details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/no-bill",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensenobill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenobill/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensebudget/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by budget.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) budget.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensebudget/index.md",
      "file": "api/insightexpensebudget/index.md",
      "searchText": "operationId insightExpenseBudget summary Insight into expenses, grouped by budget. description This endpoint gives a summary of the expenses made by the user, grouped by (any) budget.\n method get path /v1/insight/expense/budget tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name budgets[] in query description The budgets to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budget and expense details. Each budget has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/budget",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensebudget/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensenobudget/index.md",
      "kind": "operation",
      "title": "Insight into expenses, without budget.",
      "description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no budget.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensenobudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenobudget/index.md",
      "file": "api/insightexpensenobudget/index.md",
      "searchText": "operationId insightExpenseNoBudget summary Insight into expenses, without budget. description This endpoint gives a summary of the expenses made by the user, including only expenses with no budget.\n method get path /v1/insight/expense/no-budget tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of expense details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/no-budget",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensenobudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenobudget/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensecategory/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by category.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensecategory/index.md",
      "file": "api/insightexpensecategory/index.md",
      "searchText": "operationId insightExpenseCategory summary Insight into expenses, grouped by category. description This endpoint gives a summary of the expenses made by the user, grouped by (any) category.\n method get path /v1/insight/expense/category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name categories[] in query description The categories to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of category and expense details. Each category has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensecategory/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensenocategory/index.md",
      "kind": "operation",
      "title": "Insight into expenses, without category.",
      "description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensenocategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenocategory/index.md",
      "file": "api/insightexpensenocategory/index.md",
      "searchText": "operationId insightExpenseNoCategory summary Insight into expenses, without category. description This endpoint gives a summary of the expenses made by the user, including only expenses with no category.\n method get path /v1/insight/expense/no-category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of expense details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/no-category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensenocategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenocategory/index.md"
        }
      ]
    },
    {
      "id": "api/insightincomecategory/index.md",
      "kind": "operation",
      "title": "Insight into income, grouped by category.",
      "description": "This endpoint gives a summary of the income received by the user, grouped by (any) category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincomecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincomecategory/index.md",
      "file": "api/insightincomecategory/index.md",
      "searchText": "operationId insightIncomeCategory summary Insight into income, grouped by category. description This endpoint gives a summary of the income received by the user, grouped by (any) category.\n method get path /v1/insight/income/category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name categories[] in query description The categories to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of category and income details. Each category has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincomecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincomecategory/index.md"
        }
      ]
    },
    {
      "id": "api/insightincomenocategory/index.md",
      "kind": "operation",
      "title": "Insight into income, without category.",
      "description": "This endpoint gives a summary of the income received by the user, including only income with no category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincomenocategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincomenocategory/index.md",
      "file": "api/insightincomenocategory/index.md",
      "searchText": "operationId insightIncomeNoCategory summary Insight into income, without category. description This endpoint gives a summary of the income received by the user, including only income with no category.\n method get path /v1/insight/income/no-category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of income details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/no-category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincomenocategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincomenocategory/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfercategory/index.md",
      "kind": "operation",
      "title": "Insight into transfers, grouped by category.",
      "description": "This endpoint gives a summary of the transfers made by the user, grouped by (any) category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfercategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfercategory/index.md",
      "file": "api/insighttransfercategory/index.md",
      "searchText": "operationId insightTransferCategory summary Insight into transfers, grouped by category. description This endpoint gives a summary of the transfers made by the user, grouped by (any) category.\n method get path /v1/insight/transfer/category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name categories[] in query description The categories to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of category and transfer details. Each category has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfercategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfercategory/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfernocategory/index.md",
      "kind": "operation",
      "title": "Insight into transfers, without category.",
      "description": "This endpoint gives a summary of the transfers made by the user, including only transfers with no category.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfernocategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfernocategory/index.md",
      "file": "api/insighttransfernocategory/index.md",
      "searchText": "operationId insightTransferNoCategory summary Insight into transfers, without category. description This endpoint gives a summary of the transfers made by the user, including only transfers with no category.\n method get path /v1/insight/transfer/no-category tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transfer details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/no-category",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfernocategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfernocategory/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensetag/index.md",
      "kind": "operation",
      "title": "Insight into expenses, grouped by tag.",
      "description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensetag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensetag/index.md",
      "file": "api/insightexpensetag/index.md",
      "searchText": "operationId insightExpenseTag summary Insight into expenses, grouped by tag. description This endpoint gives a summary of the expenses made by the user, grouped by (any) tag.\n method get path /v1/insight/expense/tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name tags[] in query description The tags to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of tag and expense details. Each tag has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensetag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensetag/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensenotag/index.md",
      "kind": "operation",
      "title": "Insight into expenses, without tag.",
      "description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensenotag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenotag/index.md",
      "file": "api/insightexpensenotag/index.md",
      "searchText": "operationId insightExpenseNoTag summary Insight into expenses, without tag. description This endpoint gives a summary of the expenses made by the user, including only expenses with no tag.\n method get path /v1/insight/expense/no-tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of expense details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/no-tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensenotag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensenotag/index.md"
        }
      ]
    },
    {
      "id": "api/insightincometag/index.md",
      "kind": "operation",
      "title": "Insight into income, grouped by tag.",
      "description": "This endpoint gives a summary of the income received by the user, grouped by (any) tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincometag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincometag/index.md",
      "file": "api/insightincometag/index.md",
      "searchText": "operationId insightIncomeTag summary Insight into income, grouped by tag. description This endpoint gives a summary of the income received by the user, grouped by (any) tag.\n method get path /v1/insight/income/tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name tags[] in query description The tags to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of tag and income details. Each tag has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincometag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincometag/index.md"
        }
      ]
    },
    {
      "id": "api/insightincomenotag/index.md",
      "kind": "operation",
      "title": "Insight into income, without tag.",
      "description": "This endpoint gives a summary of the income received by the user, including only income with no tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincomenotag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincomenotag/index.md",
      "file": "api/insightincomenotag/index.md",
      "searchText": "operationId insightIncomeNoTag summary Insight into income, without tag. description This endpoint gives a summary of the income received by the user, including only income with no tag.\n method get path /v1/insight/income/no-tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of income details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/no-tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincomenotag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincomenotag/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfertag/index.md",
      "kind": "operation",
      "title": "Insight into transfers, grouped by tag.",
      "description": "This endpoint gives a summary of the transfers created by the user, grouped by (any) tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfertag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfertag/index.md",
      "file": "api/insighttransfertag/index.md",
      "searchText": "operationId insightTransferTag summary Insight into transfers, grouped by tag. description This endpoint gives a summary of the transfers created by the user, grouped by (any) tag.\n method get path /v1/insight/transfer/tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name tags[] in query description The tags to be included in the results.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of tag and transfer details. Each tag has one row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfertag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfertag/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfernotag/index.md",
      "kind": "operation",
      "title": "Insight into expenses, without tag.",
      "description": "This endpoint gives a summary of the transfers made by the user, including only transfers with no tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfernotag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfernotag/index.md",
      "file": "api/insighttransfernotag/index.md",
      "searchText": "operationId insightTransferNoTag summary Insight into expenses, without tag. description This endpoint gives a summary of the transfers made by the user, including only transfers with no tag.\n method get path /v1/insight/transfer/no-tag tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transfer details. One row per currency. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/no-tag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfernotag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfernotag/index.md"
        }
      ]
    },
    {
      "id": "api/insightexpensetotal/index.md",
      "kind": "operation",
      "title": "Insight into total expenses.",
      "description": "This endpoint gives a sum of the total expenses made by the user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightexpensetotal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensetotal/index.md",
      "file": "api/insightexpensetotal/index.md",
      "searchText": "operationId insightExpenseTotal summary Insight into total expenses. description This endpoint gives a sum of the total expenses made by the user.\n method get path /v1/insight/expense/total tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of sums in different currencies. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/expense/total",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightexpensetotal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightexpensetotal/index.md"
        }
      ]
    },
    {
      "id": "api/insightincometotal/index.md",
      "kind": "operation",
      "title": "Insight into total income.",
      "description": "This endpoint gives a sum of the total income received by the user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insightincometotal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insightincometotal/index.md",
      "file": "api/insightincometotal/index.md",
      "searchText": "operationId insightIncomeTotal summary Insight into total income. description This endpoint gives a sum of the total income received by the user.\n method get path /v1/insight/income/total tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of sums in different currencies. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/income/total",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insightincometotal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insightincometotal/index.md"
        }
      ]
    },
    {
      "id": "api/insighttransfertotal/index.md",
      "kind": "operation",
      "title": "Insight into total transfers.",
      "description": "This endpoint gives a sum of the total amount transfers made by the user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/insighttransfertotal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfertotal/index.md",
      "file": "api/insighttransfertotal/index.md",
      "searchText": "operationId insightTransferTotal summary Insight into total transfers. description This endpoint gives a sum of the total amount transfers made by the user.\n method get path /v1/insight/transfer/total tags 0 insight parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name accounts[] in query description The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of sums in different currencies. content application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/insight/transfer/total",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/insighttransfertotal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/insighttransfertotal/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbyaccount/index.md",
      "kind": "operation",
      "title": "List all transactions related to the account.",
      "description": "This endpoint returns a list of all the transactions connected to the account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbyaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbyaccount/index.md",
      "file": "api/listtransactionbyaccount/index.md",
      "searchText": "operationId listTransactionByAccount summary List all transactions related to the account. description This endpoint returns a list of all the transactions connected to the account.\n method get path /v1/accounts/{id}/transactions tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/accounts/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbyaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbyaccount/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbyaccount/index.md",
      "kind": "operation",
      "title": "Lists all attachments.",
      "description": "GET /v1/accounts/{id}/attachments: returns AttachmentArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbyaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbyaccount/index.md",
      "file": "api/listattachmentbyaccount/index.md",
      "searchText": "operationId listAttachmentByAccount summary Lists all attachments. description Lists all attachments. method get path /v1/accounts/{id}/attachments tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/accounts/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbyaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbyaccount/index.md"
        }
      ]
    },
    {
      "id": "api/listpiggybankbyaccount/index.md",
      "kind": "operation",
      "title": "List all piggy banks related to the account.",
      "description": "This endpoint returns a list of all the piggy banks connected to the account.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listpiggybankbyaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybankbyaccount/index.md",
      "file": "api/listpiggybankbyaccount/index.md",
      "searchText": "operationId listPiggyBankByAccount summary List all piggy banks related to the account. description This endpoint returns a list of all the piggy banks connected to the account.\n method get path /v1/accounts/{id}/piggy-banks tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy banks content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/accounts/{id}/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listpiggybankbyaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybankbyaccount/index.md"
        }
      ]
    },
    {
      "id": "api/listaccount/index.md",
      "kind": "operation",
      "title": "List all accounts.",
      "description": "This endpoint returns a list of all the accounts owned by the authenticated user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listaccount/index.md",
      "file": "api/listaccount/index.md",
      "searchText": "operationId listAccount summary List all accounts. description This endpoint returns a list of all the accounts owned by the authenticated user.\n method get path /v1/accounts tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name active in query description Should the endpoint return only active objects or inactive ones? Will be both if not applied. required  deprecated  style  explode  allowReserved  schema name  type boolean format boolean title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD. May be omitted.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD. Must be after \"start\". Can not be the same as \"start\". May be omitted.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  6 name date in query description A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  7 name type in query description Optional filter on the account type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 asset 2 cash 3 expense 4 revenue 5 special 6 hidden 7 liability 8 liabilities 9 Default account 10 Cash account 11 Asset account 12 Expense account 13 Revenue account 14 Initial balance account 15 Beneficiary account 16 Import account 17 Reconciliation account 18 Loan 19 Debt 20 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of accounts content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listaccount/index.md"
        }
      ]
    },
    {
      "id": "api/storeaccount/index.md",
      "kind": "operation",
      "title": "Create new account.",
      "description": "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).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storeaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storeaccount/index.md",
      "file": "api/storeaccount/index.md",
      "searchText": "operationId storeAccount summary Create new account. description 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). method post path /v1/accounts tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array with the necessary account information or key=value pairs. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default 0 enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default 0 enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New account stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storeaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storeaccount/index.md"
        }
      ]
    },
    {
      "id": "api/getaccount/index.md",
      "kind": "operation",
      "title": "Get single account.",
      "description": "Returns a single account by its ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getaccount/index.md",
      "file": "api/getaccount/index.md",
      "searchText": "operationId getAccount summary Get single account. description Returns a single account by its ID.\n method get path /v1/accounts/{id} tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD. May be omitted.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD. Must be after \"start\". Can not be the same as \"start\". May be omitted.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name date in query description A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested account content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/accounts/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getaccount/index.md"
        }
      ]
    },
    {
      "id": "api/updateaccount/index.md",
      "kind": "operation",
      "title": "Update existing account.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updateaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updateaccount/index.md",
      "file": "api/updateaccount/index.md",
      "searchText": "operationId updateAccount summary Update existing account. description 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.\n method put path /v1/accounts/{id} tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or form-data with updated account information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated account stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/accounts/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updateaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updateaccount/index.md"
        }
      ]
    },
    {
      "id": "api/deleteaccount/index.md",
      "kind": "operation",
      "title": "Permanently delete account.",
      "description": "Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleteaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleteaccount/index.md",
      "file": "api/deleteaccount/index.md",
      "searchText": "operationId deleteAccount summary Permanently delete account. description Will permanently delete an account. Any associated transactions and piggy banks are ALSO deleted. Cannot be recovered from.\n method delete path /v1/accounts/{id} tags 0 accounts parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Account deleted content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/accounts/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleteaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleteaccount/index.md"
        }
      ]
    },
    {
      "id": "api/listattachment/index.md",
      "kind": "operation",
      "title": "List all attachments.",
      "description": "This endpoint lists all attachments.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachment/index.md",
      "file": "api/listattachment/index.md",
      "searchText": "operationId listAttachment summary List all attachments. description This endpoint lists all attachments.\n method get path /v1/attachments tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachment/index.md"
        }
      ]
    },
    {
      "id": "api/storeattachment/index.md",
      "kind": "operation",
      "title": "Store a new attachment.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storeattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storeattachment/index.md",
      "file": "api/storeattachment/index.md",
      "searchText": "operationId storeAttachment summary Store a new attachment. description 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.\n method post path /v1/attachments tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary attachment information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentStore properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  required 0 filename 1 attachable_type 2 attachable_id example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentStore properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  required 0 filename 1 attachable_type 2 attachable_id example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New attachment stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storeattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storeattachment/index.md"
        }
      ]
    },
    {
      "id": "api/getattachment/index.md",
      "kind": "operation",
      "title": "Get a single attachment.",
      "description": "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).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getattachment/index.md",
      "file": "api/getattachment/index.md",
      "searchText": "operationId getAttachment summary Get a single attachment. description 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).\n method get path /v1/attachments/{id} tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the attachment. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested attachment content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/attachments/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getattachment/index.md"
        }
      ]
    },
    {
      "id": "api/updateattachment/index.md",
      "kind": "operation",
      "title": "Update existing attachment.",
      "description": "Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updateattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updateattachment/index.md",
      "file": "api/updateattachment/index.md",
      "searchText": "operationId updateAttachment summary Update existing attachment. description Update the meta data for an existing attachment. This endpoint does not allow you to upload or download data. For that, see below.\n method put path /v1/attachments/{id} tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the attachment. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated attachment information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentUpdate properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentUpdate properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated attachment stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/attachments/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updateattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updateattachment/index.md"
        }
      ]
    },
    {
      "id": "api/deleteattachment/index.md",
      "kind": "operation",
      "title": "Delete an attachment.",
      "description": "With this endpoint you delete an attachment, including any stored file data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleteattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleteattachment/index.md",
      "file": "api/deleteattachment/index.md",
      "searchText": "operationId deleteAttachment summary Delete an attachment. description With this endpoint you delete an attachment, including any stored file data.\n method delete path /v1/attachments/{id} tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the single attachment. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Attachment deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/attachments/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleteattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleteattachment/index.md"
        }
      ]
    },
    {
      "id": "api/downloadattachment/index.md",
      "kind": "operation",
      "title": "Download a single attachment.",
      "description": "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\".",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/downloadattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/downloadattachment/index.md",
      "file": "api/downloadattachment/index.md",
      "searchText": "operationId downloadAttachment summary Download a single attachment. description 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\".\n method get path /v1/attachments/{id}/download tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the attachment. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested attachment content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/attachments/{id}/download",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/downloadattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/downloadattachment/index.md"
        }
      ]
    },
    {
      "id": "api/uploadattachment/index.md",
      "kind": "operation",
      "title": "Upload an attachment.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/uploadattachment/",
      "markdown": "https://sourcey-firefly.pages.dev/api/uploadattachment/index.md",
      "file": "api/uploadattachment/index.md",
      "searchText": "operationId uploadAttachment summary Upload an attachment. description 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.\n method post path /v1/attachments/{id}/upload tags 0 attachments parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the attachment. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description  required  content application/octet-stream schema name  type string format binary title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 204 summary  description Upload was a success content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/attachments/{id}/upload",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/uploadattachment/",
          "markdown": "https://sourcey-firefly.pages.dev/api/uploadattachment/index.md"
        }
      ]
    },
    {
      "id": "api/listavailablebudgets/index.md",
      "kind": "operation",
      "title": "List all available budget amounts.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listavailablebudgets/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listavailablebudgets/index.md",
      "file": "api/listavailablebudgets/index.md",
      "searchText": "operationId listAvailableBudgets summary List all available budget amounts. description 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.\n method get path /v1/available-budgets tags 0 available_budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of available budget amounts. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/available-budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listavailablebudgets/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listavailablebudgets/index.md"
        }
      ]
    },
    {
      "id": "api/getavailablebudget/index.md",
      "kind": "operation",
      "title": "Get a single available budget.",
      "description": "Get a single available budget, by ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getavailablebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getavailablebudget/index.md",
      "file": "api/getavailablebudget/index.md",
      "searchText": "operationId getAvailableBudget summary Get a single available budget. description Get a single available budget, by ID. method get path /v1/available-budgets/{id} tags 0 available_budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the available budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested available budget content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/available-budgets/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getavailablebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getavailablebudget/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbybill/index.md",
      "kind": "operation",
      "title": "List all attachments uploaded to the bill.",
      "description": "This endpoint will list all attachments linked to the bill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbybill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbybill/index.md",
      "file": "api/listattachmentbybill/index.md",
      "searchText": "operationId listAttachmentByBill summary List all attachments uploaded to the bill. description This endpoint will list all attachments linked to the bill. method get path /v1/bills/{id}/attachments tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/bills/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbybill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbybill/index.md"
        }
      ]
    },
    {
      "id": "api/listrulebybill/index.md",
      "kind": "operation",
      "title": "List all rules associated with the bill.",
      "description": "This endpoint will list all rules that have an action to set the bill to this bill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrulebybill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrulebybill/index.md",
      "file": "api/listrulebybill/index.md",
      "searchText": "operationId listRuleByBill summary List all rules associated with the bill. description This endpoint will list all rules that have an action to set the bill to this bill. method get path /v1/bills/{id}/rules tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rules content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/bills/{id}/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrulebybill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrulebybill/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbybill/index.md",
      "kind": "operation",
      "title": "List all transactions associated with the  bill.",
      "description": "This endpoint will list all transactions linked to this bill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybill/index.md",
      "file": "api/listtransactionbybill/index.md",
      "searchText": "operationId listTransactionByBill summary List all transactions associated with the  bill. description This endpoint will list all transactions linked to this bill. method get path /v1/bills/{id}/transactions tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/bills/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybill/index.md"
        }
      ]
    },
    {
      "id": "api/listbill/index.md",
      "kind": "operation",
      "title": "List all bills.",
      "description": "This endpoint will list all the user's bills.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbill/index.md",
      "file": "api/listbill/index.md",
      "searchText": "operationId listBill summary List all bills. description This endpoint will list all the user's bills. method get path /v1/bills tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of bills content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbill/index.md"
        }
      ]
    },
    {
      "id": "api/storebill/index.md",
      "kind": "operation",
      "title": "Store a new bill",
      "description": "Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storebill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storebill/index.md",
      "file": "api/storebill/index.md",
      "searchText": "operationId storeBill summary Store a new bill description Creates a new bill. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/bills tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary bill information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillStore properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 amount_min 2 amount_max 3 date 4 repeat_freq example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillStore properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 amount_min 2 amount_max 3 date 4 repeat_freq example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New bill stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storebill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storebill/index.md"
        }
      ]
    },
    {
      "id": "api/getbill/index.md",
      "kind": "operation",
      "title": "Get a single bill.",
      "description": "GET /v1/bills/{id}: returns BillSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbill/index.md",
      "file": "api/getbill/index.md",
      "searchText": "operationId getBill summary Get a single bill. description Get a single bill. method get path /v1/bills/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested bill content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/bills/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbill/index.md"
        }
      ]
    },
    {
      "id": "api/updatebill/index.md",
      "kind": "operation",
      "title": "Update existing bill.",
      "description": "PUT /v1/bills/{id}: takes BillUpdate, returns BillSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatebill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatebill/index.md",
      "file": "api/updatebill/index.md",
      "searchText": "operationId updateBill summary Update existing bill. description Update existing bill. method put path /v1/bills/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or key=value pairs with updated bill information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillUpdate properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillUpdate properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated bill stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/bills/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatebill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatebill/index.md"
        }
      ]
    },
    {
      "id": "api/deletebill/index.md",
      "kind": "operation",
      "title": "Delete a bill.",
      "description": "Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletebill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletebill/index.md",
      "file": "api/deletebill/index.md",
      "searchText": "operationId deleteBill summary Delete a bill. description Delete a bill. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments. method delete path /v1/bills/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the bill. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Bill deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/bills/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletebill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletebill/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbybudgetlimit/index.md",
      "kind": "operation",
      "title": "List all transactions by a budget limit ID.",
      "description": "List all the transactions within one budget limit. The start and end date are dictated by the budget limit.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybudgetlimit/index.md",
      "file": "api/listtransactionbybudgetlimit/index.md",
      "searchText": "operationId listTransactionByBudgetLimit summary List all transactions by a budget limit ID. description List all the transactions within one budget limit. The start and end date are dictated by the budget limit. method get path /v1/budgets/{id}/limits/{limitId}/transactions tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the budget. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name limitId in path description The ID of the budget limit. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  5 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}/limits/{limitId}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/listbudgetlimitbybudget/index.md",
      "kind": "operation",
      "title": "Get all limits for a budget.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbybudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbybudget/index.md",
      "file": "api/listbudgetlimitbybudget/index.md",
      "searchText": "operationId listBudgetLimitByBudget summary Get all limits for a budget. description 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.\n method get path /v1/budgets/{id}/limits tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the requested budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budget limits applicable to this budget. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}/limits",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbybudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbybudget/index.md"
        }
      ]
    },
    {
      "id": "api/storebudgetlimit/index.md",
      "kind": "operation",
      "title": "Store new budget limit.",
      "description": "Store a new budget limit under this budget.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storebudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storebudgetlimit/index.md",
      "file": "api/storebudgetlimit/index.md",
      "searchText": "operationId storeBudgetLimit summary Store new budget limit. description Store a new budget limit under this budget. method post path /v1/budgets/{id}/limits tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitStore properties currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  start name  type string format date title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  end name  type string format date title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 start 2 end 3 budget_id example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitStore properties currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  start name  type string format date title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  end name  type string format date title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 start 2 end 3 budget_id example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New budget limit stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/budgets/{id}/limits",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storebudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storebudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/getbudgetlimit/index.md",
      "kind": "operation",
      "title": "Get single budget limit.",
      "description": "GET /v1/budgets/{id}/limits/{limitId}: returns BudgetLimitSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbudgetlimit/index.md",
      "file": "api/getbudgetlimit/index.md",
      "searchText": "operationId getBudgetLimit summary Get single budget limit. description  method get path /v1/budgets/{id}/limits/{limitId} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name limitId in path description The ID of the budget limit. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  minimum 1 content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested budget limit content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}/limits/{limitId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/updatebudgetlimit/index.md",
      "kind": "operation",
      "title": "Update existing budget limit.",
      "description": "PUT /v1/budgets/{id}/limits/{limitId}: takes BudgetLimitUpdate, returns BudgetLimitSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatebudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatebudgetlimit/index.md",
      "file": "api/updatebudgetlimit/index.md",
      "searchText": "operationId updateBudgetLimit summary Update existing budget limit. description Update existing budget limit. method put path /v1/budgets/{id}/limits/{limitId} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name limitId in path description The ID of the budget limit. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated budget limit information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitUpdate properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent name  type string format amount title  description Will be in the primary currency if this is turned on by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitUpdate properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent name  type string format amount title  description Will be in the primary currency if this is turned on by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated budget limit stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/budgets/{id}/limits/{limitId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatebudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatebudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/deletebudgetlimit/index.md",
      "kind": "operation",
      "title": "Delete a budget limit.",
      "description": "DELETE /v1/budgets/{id}/limits/{limitId}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletebudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletebudgetlimit/index.md",
      "file": "api/deletebudgetlimit/index.md",
      "searchText": "operationId deleteBudgetLimit summary Delete a budget limit. description Delete a budget limit. method delete path /v1/budgets/{id}/limits/{limitId} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name limitId in path description The ID of the budget limit. The budget limit MUST be associated to the budget ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Budget limit deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/budgets/{id}/limits/{limitId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletebudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletebudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/listbudgetlimit/index.md",
      "kind": "operation",
      "title": "Get list of budget limits by date",
      "description": "Get all budget limits for for this date range.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimit/index.md",
      "file": "api/listbudgetlimit/index.md",
      "searchText": "operationId listBudgetLimit summary Get list of budget limits by date description Get all budget limits for for this date range.\n method get path /v1/budget-limits tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budget limits. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budget-limits",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimit/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbybudget/index.md",
      "kind": "operation",
      "title": "All transactions to a budget.",
      "description": "Get all transactions linked to a budget, possibly limited by start and end",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybudget/index.md",
      "file": "api/listtransactionbybudget/index.md",
      "searchText": "operationId listTransactionByBudget summary All transactions to a budget. description Get all transactions linked to a budget, possibly limited by start and end method get path /v1/budgets/{id}/transactions tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbybudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbybudget/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbybudget/index.md",
      "kind": "operation",
      "title": "Lists all attachments of a budget.",
      "description": "Lists all attachments.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbybudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbybudget/index.md",
      "file": "api/listattachmentbybudget/index.md",
      "searchText": "operationId listAttachmentByBudget summary Lists all attachments of a budget. description Lists all attachments. method get path /v1/budgets/{id}/attachments tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbybudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbybudget/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionwithoutbudget/index.md",
      "kind": "operation",
      "title": "All transactions without a budget.",
      "description": "Get all transactions NOT linked to a budget, possibly limited by start and end",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionwithoutbudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionwithoutbudget/index.md",
      "file": "api/listtransactionwithoutbudget/index.md",
      "searchText": "operationId listTransactionWithoutBudget summary All transactions without a budget. description Get all transactions NOT linked to a budget, possibly limited by start and end method get path /v1/budgets/transactions-without-budget tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/transactions-without-budget",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionwithoutbudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionwithoutbudget/index.md"
        }
      ]
    },
    {
      "id": "api/listbudget/index.md",
      "kind": "operation",
      "title": "List all budgets.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbudget/index.md",
      "file": "api/listbudget/index.md",
      "searchText": "operationId listBudget summary List all budgets. description 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. method get path /v1/budgets tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD, to get info on how much the user has spent. You must submit both start and end.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD, to get info on how much the user has spent. You must submit both start and end.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budgets. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbudget/index.md"
        }
      ]
    },
    {
      "id": "api/storebudget/index.md",
      "kind": "operation",
      "title": "Store a new budget",
      "description": "Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storebudget/index.md",
      "file": "api/storebudget/index.md",
      "searchText": "operationId storeBudget summary Store a new budget description Creates a new budget. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/budgets tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary budget information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New budget stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storebudget/index.md"
        }
      ]
    },
    {
      "id": "api/getbudget/index.md",
      "kind": "operation",
      "title": "Get a single budget.",
      "description": "Get a single budget. If the start date and end date are submitted as well, the \"spent\" array will be updated accordingly.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbudget/index.md",
      "file": "api/getbudget/index.md",
      "searchText": "operationId getBudget summary Get a single budget. description Get a single budget. If the start date and end date are submitted as well, the \"spent\" array will be updated accordingly. method get path /v1/budgets/{id} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the requested budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD, to get info on how much the user has spent.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD, to get info on how much the user has spent.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested budget content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/budgets/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbudget/index.md"
        }
      ]
    },
    {
      "id": "api/updatebudget/index.md",
      "kind": "operation",
      "title": "Update existing budget.",
      "description": "Update existing budget. This endpoint cannot be used to set budget amount limits.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatebudget/index.md",
      "file": "api/updatebudget/index.md",
      "searchText": "operationId updateBudget summary Update existing budget. description Update existing budget. This endpoint cannot be used to set budget amount limits. method put path /v1/budgets/{id} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated budget information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated budget stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/budgets/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatebudget/index.md"
        }
      ]
    },
    {
      "id": "api/deletebudget/index.md",
      "kind": "operation",
      "title": "Delete a budget.",
      "description": "Delete a budget. Transactions will not be deleted.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletebudget/index.md",
      "file": "api/deletebudget/index.md",
      "searchText": "operationId deleteBudget summary Delete a budget. description Delete a budget. Transactions will not be deleted. method delete path /v1/budgets/{id} tags 0 budgets parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the budget. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Budget deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/budgets/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletebudget/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbycategory/index.md",
      "kind": "operation",
      "title": "List all transactions in a category.",
      "description": "List all transactions in a category, optionally limited to the date ranges specified.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbycategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbycategory/index.md",
      "file": "api/listtransactionbycategory/index.md",
      "searchText": "operationId listTransactionByCategory summary List all transactions in a category. description List all transactions in a category, optionally limited to the date ranges specified. method get path /v1/categories/{id}/transactions tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the category. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD, to limit the result list.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD, to limit the result list.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/categories/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbycategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbycategory/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbycategory/index.md",
      "kind": "operation",
      "title": "Lists all attachments.",
      "description": "GET /v1/categories/{id}/attachments: returns AttachmentArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbycategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbycategory/index.md",
      "file": "api/listattachmentbycategory/index.md",
      "searchText": "operationId listAttachmentByCategory summary Lists all attachments. description Lists all attachments. method get path /v1/categories/{id}/attachments tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the category. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/categories/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbycategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbycategory/index.md"
        }
      ]
    },
    {
      "id": "api/listcategory/index.md",
      "kind": "operation",
      "title": "List all categories.",
      "description": "GET /v1/categories: returns CategoryArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listcategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listcategory/index.md",
      "file": "api/listcategory/index.md",
      "searchText": "operationId listCategory summary List all categories. description List all categories. method get path /v1/categories tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of categories. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/categories",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listcategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listcategory/index.md"
        }
      ]
    },
    {
      "id": "api/storecategory/index.md",
      "kind": "operation",
      "title": "Store a new category",
      "description": "Creates a new category. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storecategory/index.md",
      "file": "api/storecategory/index.md",
      "searchText": "operationId storeCategory summary Store a new category description Creates a new category. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/categories tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary category information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New category stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategorySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/categories",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storecategory/index.md"
        }
      ]
    },
    {
      "id": "api/getcategory/index.md",
      "kind": "operation",
      "title": "Get a single category.",
      "description": "GET /v1/categories/{id}: returns CategorySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcategory/index.md",
      "file": "api/getcategory/index.md",
      "searchText": "operationId getCategory summary Get a single category. description Get a single category. method get path /v1/categories/{id} tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the category. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD, to show spent and earned info.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD, to show spent and earned info.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested category content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategorySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/categories/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcategory/index.md"
        }
      ]
    },
    {
      "id": "api/updatecategory/index.md",
      "kind": "operation",
      "title": "Update existing category.",
      "description": "PUT /v1/categories/{id}: takes CategoryUpdate, returns CategorySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatecategory/index.md",
      "file": "api/updatecategory/index.md",
      "searchText": "operationId updateCategory summary Update existing category. description Update existing category. method put path /v1/categories/{id} tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the category. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated category information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated category stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategorySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/categories/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatecategory/index.md"
        }
      ]
    },
    {
      "id": "api/deletecategory/index.md",
      "kind": "operation",
      "title": "Delete a category.",
      "description": "Delete a category. Transactions will not be removed.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletecategory/index.md",
      "file": "api/deletecategory/index.md",
      "searchText": "operationId deleteCategory summary Delete a category. description Delete a category. Transactions will not be removed. method delete path /v1/categories/{id} tags 0 categories parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the category. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Category deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/categories/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletecategory/index.md"
        }
      ]
    },
    {
      "id": "api/listcurrencyexchangerates/index.md",
      "kind": "operation",
      "title": "List all exchange rates that Firefly III knows.",
      "description": "List exchange rates that Firefly III knows.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listcurrencyexchangerates/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listcurrencyexchangerates/index.md",
      "file": "api/listcurrencyexchangerates/index.md",
      "searchText": "operationId listCurrencyExchangeRates summary List all exchange rates that Firefly III knows. description List exchange rates that Firefly III knows. method get path /v1/exchange-rates tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of all available currency exchange rates. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/exchange-rates",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listcurrencyexchangerates/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listcurrencyexchangerates/index.md"
        }
      ]
    },
    {
      "id": "api/storecurrencyexchangerate/index.md",
      "kind": "operation",
      "title": "Store a new currency exchange rate.",
      "description": "Stores a new exchange rate. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangerate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangerate/index.md",
      "file": "api/storecurrencyexchangerate/index.md",
      "searchText": "operationId storeCurrencyExchangeRate summary Store a new currency exchange rate. description Stores a new exchange rate. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/exchange-rates tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary exchange rate information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateStore properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  required 0 date 1 from 2 to 3 rates example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateStore properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  required 0 date 1 from 2 to 3 rates example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New exchange stored, result in response. If a rate already exists for this currency pair and date, it will be updated. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/exchange-rates",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangerate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangerate/index.md"
        }
      ]
    },
    {
      "id": "api/listspecificcurrencyexchangerate/index.md",
      "kind": "operation",
      "title": "List a single specific exchange rate.",
      "description": "List a single specific exchange rate by its ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerate/index.md",
      "file": "api/listspecificcurrencyexchangerate/index.md",
      "searchText": "operationId listSpecificCurrencyExchangeRate summary List a single specific exchange rate. description List a single specific exchange rate by its ID. method get path /v1/exchange-rates/{id} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the requested currency exchange rate. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The exchange rate requested. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/exchange-rates/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerate/index.md"
        }
      ]
    },
    {
      "id": "api/updatecurrencyexchangerate/index.md",
      "kind": "operation",
      "title": "Update existing currency exchange rate.",
      "description": "Used to update a single currency exchange rate by its ID. Including the from/to currency is optional.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangerate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangerate/index.md",
      "file": "api/updatecurrencyexchangerate/index.md",
      "searchText": "operationId updateCurrencyExchangeRate summary Update existing currency exchange rate. description Used to update a single currency exchange rate by its ID. Including the from/to currency is optional.\n method put path /v1/exchange-rates/{id} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the currency exchange rate. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or form-data with updated exchange rate information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdate properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 date 1 rate example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdate properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 date 1 rate example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated exchange rate stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/exchange-rates/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangerate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangerate/index.md"
        }
      ]
    },
    {
      "id": "api/deletespecificcurrencyexchangerate/index.md",
      "kind": "operation",
      "title": "Delete a specific currency exchange rate.",
      "description": "Delete a specific currency exchange rate by its internal ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerate/index.md",
      "file": "api/deletespecificcurrencyexchangerate/index.md",
      "searchText": "operationId deleteSpecificCurrencyExchangeRate summary Delete a specific currency exchange rate. description Delete a specific currency exchange rate by its internal ID. method delete path /v1/exchange-rates/{id} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the requested currency exchange rate. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency exchange rate deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/exchange-rates/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerate/index.md"
        }
      ]
    },
    {
      "id": "api/listspecificcurrencyexchangerates/index.md",
      "kind": "operation",
      "title": "List all exchange rates from/to the mentioned currencies.",
      "description": "GET /v1/exchange-rates/{from}/{to}: returns CurrencyExchangeRateArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerates/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerates/index.md",
      "file": "api/listspecificcurrencyexchangerates/index.md",
      "searchText": "operationId listSpecificCurrencyExchangeRates summary List all exchange rates from/to the mentioned currencies. description List all exchange rates from/to the mentioned currencies. method get path /v1/exchange-rates/{from}/{to} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  4 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of currency exchange rates. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/exchange-rates/{from}/{to}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerates/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerates/index.md"
        }
      ]
    },
    {
      "id": "api/deletespecificcurrencyexchangerates/index.md",
      "kind": "operation",
      "title": "Deletes ALL currency exchange rates from 'from' to 'to'.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerates/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerates/index.md",
      "file": "api/deletespecificcurrencyexchangerates/index.md",
      "searchText": "operationId deleteSpecificCurrencyExchangeRates summary Deletes ALL currency exchange rates from 'from' to 'to'. description 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. method delete path /v1/exchange-rates/{from}/{to} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  2 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency exchange rate(s) deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/exchange-rates/{from}/{to}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerates/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerates/index.md"
        }
      ]
    },
    {
      "id": "api/listspecificcurrencyexchangerateondate/index.md",
      "kind": "operation",
      "title": "List the exchange rate for the from and to-currency on the requested date.",
      "description": "GET /v1/exchange-rates/{from}/{to}/{date}: returns CurrencyExchangeRateArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerateondate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerateondate/index.md",
      "file": "api/listspecificcurrencyexchangerateondate/index.md",
      "searchText": "operationId listSpecificCurrencyExchangeRateOnDate summary List the exchange rate for the from and to-currency on the requested date. description List the exchange rate for the from and to-currency on the requested date. method get path /v1/exchange-rates/{from}/{to}/{date} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  4 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  5 name date in path description  required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 2026-10-01 examples  requestBody  responses 0 statusCode 200 summary  description A list of currency exchange rates. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/exchange-rates/{from}/{to}/{date}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerateondate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listspecificcurrencyexchangerateondate/index.md"
        }
      ]
    },
    {
      "id": "api/updatecurrencyexchangeratebydate/index.md",
      "kind": "operation",
      "title": "Update existing currency exchange rate.",
      "description": "Used to update a single currency exchange rate by its currency codes and date",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangeratebydate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangeratebydate/index.md",
      "file": "api/updatecurrencyexchangeratebydate/index.md",
      "searchText": "operationId updateCurrencyExchangeRateByDate summary Update existing currency exchange rate. description Used to update a single currency exchange rate by its currency codes and date\n method put path /v1/exchange-rates/{from}/{to}/{date} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  2 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  3 name date in path description  required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 2026-10-01 examples  requestBody description JSON array or form-data with updated exchange rate information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdateNoDate properties rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  required 0 rate example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdate properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 date 1 rate example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated exchange rate stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/exchange-rates/{from}/{to}/{date}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangeratebydate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrencyexchangeratebydate/index.md"
        }
      ]
    },
    {
      "id": "api/deletespecificcurrencyexchangerateondate/index.md",
      "kind": "operation",
      "title": "Delete the currency exchange rate from 'from' to 'to' on the specified date.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerateondate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerateondate/index.md",
      "file": "api/deletespecificcurrencyexchangerateondate/index.md",
      "searchText": "operationId deleteSpecificCurrencyExchangeRateOnDate summary Delete the currency exchange rate from 'from' to 'to' on the specified date. description 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. method delete path /v1/exchange-rates/{from}/{to}/{date} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  2 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  3 name date in path description  required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 2026-10-01 examples  requestBody  responses 0 statusCode 204 summary  description Currency exchange rate(s) deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/exchange-rates/{from}/{to}/{date}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerateondate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletespecificcurrencyexchangerateondate/index.md"
        }
      ]
    },
    {
      "id": "api/storecurrencyexchangeratesbydate/index.md",
      "kind": "operation",
      "title": "Store new currency exchange rates under this date",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbydate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbydate/index.md",
      "file": "api/storecurrencyexchangeratesbydate/index.md",
      "searchText": "operationId storeCurrencyExchangeRatesByDate summary Store new currency exchange rates under this date description 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. method post path /v1/exchange-rates/by-date/{date} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name date in path description  required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example 2026-10-01 examples  requestBody description JSON array with the necessary currency exchange rate information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateStoreByDate properties from name  type string format string title  description The 'from'-currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  rates name  type object format  title  description The actual entries for this data set. They 'key' value is 'to' currency. The value is the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD 1.2345 GBP 6.3456 examples  refName  additionalProperties name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 from 1 date 2 rates example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New exchange rates stored, result in response. If a rate already existed for any submitted entry, it will be updated. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/exchange-rates/by-date/{date}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbydate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbydate/index.md"
        }
      ]
    },
    {
      "id": "api/storecurrencyexchangeratesbypair/index.md",
      "kind": "operation",
      "title": "Store new currency exchange rates under this from/to pair.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbypair/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbypair/index.md",
      "file": "api/storecurrencyexchangeratesbypair/index.md",
      "searchText": "operationId storeCurrencyExchangeRatesByPair summary Store new currency exchange rates under this from/to pair. description 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. method post path /v1/exchange-rates/by-currencies/{from}/{to} tags 0 currency_exchange_rates parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name from in path description The currency code of the 'from' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  2 name to in path description The currency code of the 'to' currency. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody description JSON array with the necessary currency exchange rate information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description The actual entries for this data set. They 'key' value is the date in YYYY-MM-DD. The value is the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2025-08-01 1.2345 2025-08-02 6.3456 examples  refName CurrencyExchangeRateStoreByPair additionalProperties name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New exchange rates stored, result in response. If a rate already existed for any submitted entry, it will be updated. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/exchange-rates/by-currencies/{from}/{to}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbypair/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storecurrencyexchangeratesbypair/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbylinktype/index.md",
      "kind": "operation",
      "title": "List all transactions under this link type.",
      "description": "List all transactions under this link type, both the inward and outward transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbylinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbylinktype/index.md",
      "file": "api/listtransactionbylinktype/index.md",
      "searchText": "operationId listTransactionByLinkType summary List all transactions under this link type. description List all transactions under this link type, both the inward and outward transactions.\n method get path /v1/link-types/{id}/transactions tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the link type. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD, to limit the results.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD, to limit the results.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/link-types/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbylinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbylinktype/index.md"
        }
      ]
    },
    {
      "id": "api/listlinktype/index.md",
      "kind": "operation",
      "title": "List all types of links.",
      "description": "List all the link types the system has. These include the default ones as well as any new ones.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listlinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listlinktype/index.md",
      "file": "api/listlinktype/index.md",
      "searchText": "operationId listLinkType summary List all types of links. description List all the link types the system has. These include the default ones as well as any new ones.\n method get path /v1/link-types tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of link types. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/link-types",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listlinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listlinktype/index.md"
        }
      ]
    },
    {
      "id": "api/storelinktype/index.md",
      "kind": "operation",
      "title": "Create a new link type",
      "description": "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).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storelinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storelinktype/index.md",
      "file": "api/storelinktype/index.md",
      "searchText": "operationId storeLinkType summary Create a new link type description 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). method post path /v1/link-types tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array with the necessary link type information or key=value pairs. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New link type stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/link-types",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storelinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storelinktype/index.md"
        }
      ]
    },
    {
      "id": "api/getlinktype/index.md",
      "kind": "operation",
      "title": "Get single a link type.",
      "description": "Returns a single link type by its ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getlinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getlinktype/index.md",
      "file": "api/getlinktype/index.md",
      "searchText": "operationId getLinkType summary Get single a link type. description Returns a single link type by its ID.\n method get path /v1/link-types/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the link type. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested link type content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/link-types/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getlinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getlinktype/index.md"
        }
      ]
    },
    {
      "id": "api/updatelinktype/index.md",
      "kind": "operation",
      "title": "Update existing link type.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatelinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatelinktype/index.md",
      "file": "api/updatelinktype/index.md",
      "searchText": "operationId updateLinkType summary Update existing link type. description 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.\n method put path /v1/link-types/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the link type. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or form-data with updated link type information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated link type stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/link-types/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatelinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatelinktype/index.md"
        }
      ]
    },
    {
      "id": "api/deletelinktype/index.md",
      "kind": "operation",
      "title": "Permanently delete link type.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletelinktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletelinktype/index.md",
      "file": "api/deletelinktype/index.md",
      "searchText": "operationId deleteLinkType summary Permanently delete link type. description 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.\n method delete path /v1/link-types/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the link type. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Link type deleted content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/link-types/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletelinktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletelinktype/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionlink/index.md",
      "kind": "operation",
      "title": "List all transaction links.",
      "description": "List all the transaction links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionlink/index.md",
      "file": "api/listtransactionlink/index.md",
      "searchText": "operationId listTransactionLink summary List all transaction links. description List all the transaction links.\n method get path /v1/transaction-links tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transaction links content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transaction-links",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/storetransactionlink/index.md",
      "kind": "operation",
      "title": "Create a new link between transactions",
      "description": "Store a new link between two transactions. For this end point you need the journal_id from a transaction.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storetransactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storetransactionlink/index.md",
      "file": "api/storetransactionlink/index.md",
      "searchText": "operationId storeTransactionLink summary Create a new link between transactions description Store a new link between two transactions. For this end point you need the journal_id from a transaction. method post path /v1/transaction-links tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array with the necessary link type information or key=value pairs. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkStore properties link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkStore properties link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New transaction link stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/transaction-links",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storetransactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storetransactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/gettransactionlink/index.md",
      "kind": "operation",
      "title": "Get a single link.",
      "description": "Returns a single link by its ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionlink/index.md",
      "file": "api/gettransactionlink/index.md",
      "searchText": "operationId getTransactionLink summary Get a single link. description Returns a single link by its ID.\n method get path /v1/transaction-links/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction link. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested link content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transaction-links/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/updatetransactionlink/index.md",
      "kind": "operation",
      "title": "Update an existing link between transactions.",
      "description": "Used to update a single existing link.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatetransactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatetransactionlink/index.md",
      "file": "api/updatetransactionlink/index.md",
      "searchText": "operationId updateTransactionLink summary Update an existing link between transactions. description Used to update a single existing link.\n method put path /v1/transaction-links/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction link. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or form-data with updated link type information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkUpdate properties link_type_id name  type string format string title  description The link type ID to use. Use this field OR use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. Use this field OR use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. If you submit an empty string the current notes will be removed default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkUpdate properties link_type_id name  type string format string title  description The link type ID to use. Use this field OR use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. Use this field OR use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. If you submit an empty string the current notes will be removed default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated link type stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/transaction-links/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatetransactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatetransactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/deletetransactionlink/index.md",
      "kind": "operation",
      "title": "Permanently delete link between transactions.",
      "description": "Will permanently delete link. Transactions remain.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletetransactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletetransactionlink/index.md",
      "file": "api/deletetransactionlink/index.md",
      "searchText": "operationId deleteTransactionLink summary Permanently delete link between transactions. description Will permanently delete link. Transactions remain.\n method delete path /v1/transaction-links/{id} tags 0 links parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction link. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Transaction link deleted content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/transaction-links/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletetransactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletetransactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/listpiggybankbyobjectgroup/index.md",
      "kind": "operation",
      "title": "List all piggy banks related to the object group.",
      "description": "This endpoint returns a list of all the piggy banks connected to the object group.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listpiggybankbyobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybankbyobjectgroup/index.md",
      "file": "api/listpiggybankbyobjectgroup/index.md",
      "searchText": "operationId listPiggyBankByObjectGroup summary List all piggy banks related to the object group. description This endpoint returns a list of all the piggy banks connected to the object group.\n method get path /v1/object-groups/{id}/piggy-banks tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy banks content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/object-groups/{id}/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listpiggybankbyobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybankbyobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/listbillbyobjectgroup/index.md",
      "kind": "operation",
      "title": "List all bills with this object group.",
      "description": "GET /v1/object-groups/{id}/bills: returns BillArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbillbyobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbillbyobjectgroup/index.md",
      "file": "api/listbillbyobjectgroup/index.md",
      "searchText": "operationId listBillByObjectGroup summary List all bills with this object group. description List all bills with this object group. method get path /v1/object-groups/{id}/bills tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of bills. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/object-groups/{id}/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbillbyobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbillbyobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/listobjectgroups/index.md",
      "kind": "operation",
      "title": "List all object groups.",
      "description": "GET /v1/object-groups: returns ObjectGroupArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listobjectgroups/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listobjectgroups/index.md",
      "file": "api/listobjectgroups/index.md",
      "searchText": "operationId listObjectGroups summary List all object groups. description List all object groups. method get path /v1/object-groups tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of object groups content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/object-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listobjectgroups/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listobjectgroups/index.md"
        }
      ]
    },
    {
      "id": "api/getobjectgroup/index.md",
      "kind": "operation",
      "title": "Get a single object group.",
      "description": "GET /v1/object-groups/{id}: returns ObjectGroupSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getobjectgroup/index.md",
      "file": "api/getobjectgroup/index.md",
      "searchText": "operationId getObjectGroup summary Get a single object group. description Get a single object group. method get path /v1/object-groups/{id} tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the object group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested object group content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/object-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/updateobjectgroup/index.md",
      "kind": "operation",
      "title": "Update existing object group.",
      "description": "PUT /v1/object-groups/{id}: takes ObjectGroupUpdate, returns ObjectGroupSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updateobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updateobjectgroup/index.md",
      "file": "api/updateobjectgroup/index.md",
      "searchText": "operationId updateObjectGroup summary Update existing object group. description Update existing object group. method put path /v1/object-groups/{id} tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the object group required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated piggy bank information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated object group stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/object-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updateobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updateobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/deleteobjectgroup/index.md",
      "kind": "operation",
      "title": "Delete a object group.",
      "description": "DELETE /v1/object-groups/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleteobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleteobjectgroup/index.md",
      "file": "api/deleteobjectgroup/index.md",
      "searchText": "operationId deleteObjectGroup summary Delete a object group. description Delete a object group. method delete path /v1/object-groups/{id} tags 0 object_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the object group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Object group deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/object-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleteobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleteobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/listeventbypiggybank/index.md",
      "kind": "operation",
      "title": "List all events linked to a piggy bank.",
      "description": "List all events linked to a piggy bank (adding and removing money).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listeventbypiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listeventbypiggybank/index.md",
      "file": "api/listeventbypiggybank/index.md",
      "searchText": "operationId listEventByPiggyBank summary List all events linked to a piggy bank. description List all events linked to a piggy bank (adding and removing money). method get path /v1/piggy-banks/{id}/events tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the piggy bank required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy bank related events content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_bank_events examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_journal_id name  type string format string title  description The journal associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  transaction_group_id name  type string format string title  description The transaction group associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/piggy-banks/{id}/events",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listeventbypiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listeventbypiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbypiggybank/index.md",
      "kind": "operation",
      "title": "Lists all attachments.",
      "description": "GET /v1/piggy-banks/{id}/attachments: returns AttachmentArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbypiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbypiggybank/index.md",
      "file": "api/listattachmentbypiggybank/index.md",
      "searchText": "operationId listAttachmentByPiggyBank summary Lists all attachments. description Lists all attachments. method get path /v1/piggy-banks/{id}/attachments tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the piggy bank. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/piggy-banks/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbypiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbypiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/listaccountbypiggybank/index.md",
      "kind": "operation",
      "title": "List all accounts linked to a piggy bank.",
      "description": "List all accounts linked to a piggy bank. A piggy bank can be linked to multiple accounts.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listaccountbypiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listaccountbypiggybank/index.md",
      "file": "api/listaccountbypiggybank/index.md",
      "searchText": "operationId listAccountByPiggyBank summary List all accounts linked to a piggy bank. description List all accounts linked to a piggy bank. A piggy bank can be linked to multiple accounts. method get path /v1/piggy-banks/{id}/accounts tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the piggy bank. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of accounts content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/piggy-banks/{id}/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listaccountbypiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listaccountbypiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/listpiggybank/index.md",
      "kind": "operation",
      "title": "List all piggy banks.",
      "description": "GET /v1/piggy-banks: returns PiggyBankArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listpiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybank/index.md",
      "file": "api/listpiggybank/index.md",
      "searchText": "operationId listPiggyBank summary List all piggy banks. description List all piggy banks. method get path /v1/piggy-banks tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy banks content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listpiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listpiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/storepiggybank/index.md",
      "kind": "operation",
      "title": "Store a new piggy bank",
      "description": "Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storepiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storepiggybank/index.md",
      "file": "api/storepiggybank/index.md",
      "searchText": "operationId storePiggyBank summary Store a new piggy bank description Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/piggy-banks tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountStore properties id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 account_id 2 target_amount 3 start_date example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountStore properties id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 account_id 2 target_amount 3 start_date example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New piggy bank stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/piggy-banks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storepiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storepiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/getpiggybank/index.md",
      "kind": "operation",
      "title": "Get a single piggy bank.",
      "description": "GET /v1/piggy-banks/{id}: returns PiggyBankSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getpiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getpiggybank/index.md",
      "file": "api/getpiggybank/index.md",
      "searchText": "operationId getPiggyBank summary Get a single piggy bank. description Get a single piggy bank. method get path /v1/piggy-banks/{id} tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the piggy bank. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested piggy bank content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/piggy-banks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getpiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getpiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/updatepiggybank/index.md",
      "kind": "operation",
      "title": "Update existing piggy bank.",
      "description": "PUT /v1/piggy-banks/{id}: takes PiggyBankUpdate, returns PiggyBankSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatepiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatepiggybank/index.md",
      "file": "api/updatepiggybank/index.md",
      "searchText": "operationId updatePiggyBank summary Update existing piggy bank. description Update existing piggy bank. method put path /v1/piggy-banks/{id} tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the piggy bank required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated piggy bank information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountUpdate properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountUpdate properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated piggy bank stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/piggy-banks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatepiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatepiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/deletepiggybank/index.md",
      "kind": "operation",
      "title": "Delete a piggy bank.",
      "description": "DELETE /v1/piggy-banks/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletepiggybank/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletepiggybank/index.md",
      "file": "api/deletepiggybank/index.md",
      "searchText": "operationId deletePiggyBank summary Delete a piggy bank. description Delete a piggy bank. method delete path /v1/piggy-banks/{id} tags 0 piggy_banks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the piggy bank. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Piggy bank deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/piggy-banks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletepiggybank/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletepiggybank/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbyrecurrence/index.md",
      "kind": "operation",
      "title": "List all transactions created by a recurring transaction.",
      "description": "List all transactions created by a recurring transaction, optionally limited to the date ranges specified.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbyrecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbyrecurrence/index.md",
      "file": "api/listtransactionbyrecurrence/index.md",
      "searchText": "operationId listTransactionByRecurrence summary List all transactions created by a recurring transaction. description List all transactions created by a recurring transaction, optionally limited to the date ranges specified. method get path /v1/recurrences/{id}/transactions tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the recurring transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD. Both the start and end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD. Both the start and end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/recurrences/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbyrecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbyrecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/listrecurrence/index.md",
      "kind": "operation",
      "title": "List all recurring transactions.",
      "description": "GET /v1/recurrences: returns RecurrenceArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrecurrence/index.md",
      "file": "api/listrecurrence/index.md",
      "searchText": "operationId listRecurrence summary List all recurring transactions. description List all recurring transactions. method get path /v1/recurrences tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of recurring transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/recurrences",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/storerecurrence/index.md",
      "kind": "operation",
      "title": "Store a new recurring transaction",
      "description": "Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storerecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storerecurrence/index.md",
      "file": "api/storerecurrence/index.md",
      "searchText": "operationId storeRecurrence summary Store a new recurring transaction description Creates a new recurring transaction. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/recurrences tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary recurring transaction information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceStore properties type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionStore properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionStore properties description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 description 1 amount 2 source_id 3 destination_id required 0 type 1 title 2 first_date 3 repeat_until 4 repetitions 5 transactions example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceStore properties type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionStore properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionStore properties description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 description 1 amount 2 source_id 3 destination_id required 0 type 1 title 2 first_date 3 repeat_until 4 repetitions 5 transactions example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New recurring transaction stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/recurrences",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storerecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storerecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/getrecurrence/index.md",
      "kind": "operation",
      "title": "Get a single recurring transaction.",
      "description": "GET /v1/recurrences/{id}: returns RecurrenceSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrecurrence/index.md",
      "file": "api/getrecurrence/index.md",
      "searchText": "operationId getRecurrence summary Get a single recurring transaction. description Get a single recurring transaction. method get path /v1/recurrences/{id} tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the recurring transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested recurring transaction content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/recurrences/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/updaterecurrence/index.md",
      "kind": "operation",
      "title": "Update existing recurring transaction.",
      "description": "PUT /v1/recurrences/{id}: takes RecurrenceUpdate, returns RecurrenceSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updaterecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updaterecurrence/index.md",
      "file": "api/updaterecurrence/index.md",
      "searchText": "operationId updateRecurrence summary Update existing recurring transaction. description Update existing recurring transaction. method put path /v1/recurrences/{id} tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the recurring transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated recurring transaction information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until when the recurring transaction can fire. After that date, it's basically inactive. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionUpdate properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionUpdate properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 id example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until when the recurring transaction can fire. After that date, it's basically inactive. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionUpdate properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionUpdate properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 id example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated recurring transaction stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/recurrences/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updaterecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updaterecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/deleterecurrence/index.md",
      "kind": "operation",
      "title": "Delete a recurring transaction.",
      "description": "Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleterecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleterecurrence/index.md",
      "file": "api/deleterecurrence/index.md",
      "searchText": "operationId deleteRecurrence summary Delete a recurring transaction. description Delete a recurring transaction. Transactions created by the recurring transaction will not be deleted. method delete path /v1/recurrences/{id} tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the recurring transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Recurring transaction deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/recurrences/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleterecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleterecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/triggerrecurrencerecurrence/index.md",
      "kind": "operation",
      "title": "Trigger the creation of a transaction for a specific recurring transaction",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/triggerrecurrencerecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/triggerrecurrencerecurrence/index.md",
      "file": "api/triggerrecurrencerecurrence/index.md",
      "searchText": "operationId triggerRecurrenceRecurrence summary Trigger the creation of a transaction for a specific recurring transaction description 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_.\n\nSo, if you recurring transaction that occurs every Monday, you can trigger the creation of a transaction for Monday in two weeks, today. On that Monday two weeks from now, no transaction will be created. Instead, the transaction is created right now, and dated _today_.\n method post path /v1/recurrences/{id}/trigger tags 0 recurrences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the recurring transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name date in query description A date formatted YYYY-MM-DD. This is the date for which you want the recurrence to fire. You can take the date from the list of occurrences in the recurring transaction.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions (always just 1) created by the recurrence, or a list of zero (0) when there is nothing to create for this date. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/recurrences/{id}/trigger",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/triggerrecurrencerecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/triggerrecurrencerecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/listrulebygroup/index.md",
      "kind": "operation",
      "title": "List rules in this rule group.",
      "description": "GET /v1/rule-groups/{id}/rules: returns RuleArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrulebygroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrulebygroup/index.md",
      "file": "api/listrulebygroup/index.md",
      "searchText": "operationId listRuleByGroup summary List rules in this rule group. description List rules in this rule group. method get path /v1/rule-groups/{id}/rules tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rules. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rule-groups/{id}/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrulebygroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrulebygroup/index.md"
        }
      ]
    },
    {
      "id": "api/testrulegroup/index.md",
      "kind": "operation",
      "title": "Test which transactions would be hit by the rule group. No changes will be made.",
      "description": "Test which transactions would be hit by the rule group. No changes will be made. Limit the result if you want to.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/testrulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/testrulegroup/index.md",
      "file": "api/testrulegroup/index.md",
      "searchText": "operationId testRuleGroup summary Test which transactions would be hit by the rule group. No changes will be made. description Test which transactions would be hit by the rule group. No changes will be made. Limit the result if you want to. method get path /v1/rule-groups/{id}/test tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name search_limit in query description Maximum number of transactions Firefly III will try. Don't set this too high, or it will take Firefly III very long to run the test. I suggest a max of 200.\n required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  7 name triggered_limit in query description Maximum number of transactions the rule group can actually trigger on, before Firefly III stops. I would suggest setting this to 10 or 15. Don't go above the user's page size, because browsing to page 2 or 3 of a test result would fire the test again, making any navigation efforts very slow.\n required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  8 name accounts[] in query description Limit the testing of the rule group to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions that would be changed by any of the rules of the rule group. No changes will be made. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rule-groups/{id}/test",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/testrulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/testrulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/firerulegroup/index.md",
      "kind": "operation",
      "title": "Fire the rule group on your transactions.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/firerulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/firerulegroup/index.md",
      "file": "api/firerulegroup/index.md",
      "searchText": "operationId fireRuleGroup summary Fire the rule group on your transactions. description 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. method post path /v1/rule-groups/{id}/trigger tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  4 name accounts[] in query description Limit the triggering of the rule group to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description The rules in the group are executed. Due to the setup of this function (asynchronous job execution) the result cannot be displayed. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/rule-groups/{id}/trigger",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/firerulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/firerulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/listrulegroup/index.md",
      "kind": "operation",
      "title": "List all rule groups.",
      "description": "GET /v1/rule-groups: returns RuleGroupArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrulegroup/index.md",
      "file": "api/listrulegroup/index.md",
      "searchText": "operationId listRuleGroup summary List all rule groups. description List all rule groups. method get path /v1/rule-groups tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rule groups. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rule-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/storerulegroup/index.md",
      "kind": "operation",
      "title": "Store a new rule group.",
      "description": "Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storerulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storerulegroup/index.md",
      "file": "api/storerulegroup/index.md",
      "searchText": "operationId storeRuleGroup summary Store a new rule group. description Creates a new rule group. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/rule-groups tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary rule group information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New rule group stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/rule-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storerulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storerulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/getrulegroup/index.md",
      "kind": "operation",
      "title": "Get a single rule group.",
      "description": "Get a single rule group. This does not include the rules. For that, see below.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrulegroup/index.md",
      "file": "api/getrulegroup/index.md",
      "searchText": "operationId getRuleGroup summary Get a single rule group. description Get a single rule group. This does not include the rules. For that, see below. method get path /v1/rule-groups/{id} tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested rule group content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rule-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/updaterulegroup/index.md",
      "kind": "operation",
      "title": "Update existing rule group.",
      "description": "PUT /v1/rule-groups/{id}: takes RuleGroupUpdate, returns RuleGroupSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updaterulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updaterulegroup/index.md",
      "file": "api/updaterulegroup/index.md",
      "searchText": "operationId updateRuleGroup summary Update existing rule group. description Update existing rule group. method put path /v1/rule-groups/{id} tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated rule group information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated rule group stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/rule-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updaterulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updaterulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/deleterulegroup/index.md",
      "kind": "operation",
      "title": "Delete a rule group.",
      "description": "DELETE /v1/rule-groups/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleterulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleterulegroup/index.md",
      "file": "api/deleterulegroup/index.md",
      "searchText": "operationId deleteRuleGroup summary Delete a rule group. description Delete a rule group. method delete path /v1/rule-groups/{id} tags 0 rule_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Rule group deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/rule-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleterulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleterulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/testrule/index.md",
      "kind": "operation",
      "title": "Test which transactions would be hit by the rule. No changes will be made.",
      "description": "Test which transactions would be hit by the rule. No changes will be made. Limit the result if you want to.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/testrule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/testrule/index.md",
      "file": "api/testrule/index.md",
      "searchText": "operationId testRule summary Test which transactions would be hit by the rule. No changes will be made. description Test which transactions would be hit by the rule. No changes will be made. Limit the result if you want to. method get path /v1/rules/{id}/test tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD, to limit the transactions the test will be applied to. Both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  4 name accounts[] in query description Limit the testing of the rule to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions that would be changed by the rule. No changes will be made. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rules/{id}/test",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/testrule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/testrule/index.md"
        }
      ]
    },
    {
      "id": "api/firerule/index.md",
      "kind": "operation",
      "title": "Fire the rule on your transactions.",
      "description": "Fire the rule group on your transactions. Changes will be made by the rules in the group. Limit the result if you want to.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/firerule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/firerule/index.md",
      "file": "api/firerule/index.md",
      "searchText": "operationId fireRule summary Fire the rule on your transactions. description Fire the rule group on your transactions. Changes will be made by the rules in the group. Limit the result if you want to. method post path /v1/rules/{id}/trigger tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. If the start date is not present, it will be set to one year ago. If you use this field, both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD, to limit the transactions the actions will be applied to. If the end date is not present, it will be set to today. If you use this field, both the start date and the end date must be present.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  4 name accounts[] in query description Limit the triggering of the rule to these asset accounts or liabilities. Only asset accounts and liabilities will be accepted. Other types will be silently dropped.\n required  deprecated  style  explode  allowReserved  schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 1 1 2 2 3 examples  refName  items name  type integer format int64 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description The rules in the group are executed. Due to the setup of this function (asynchronous job execution) the result cannot be displayed. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/rules/{id}/trigger",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/firerule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/firerule/index.md"
        }
      ]
    },
    {
      "id": "api/listrule/index.md",
      "kind": "operation",
      "title": "List all rules.",
      "description": "GET /v1/rules: returns RuleArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrule/index.md",
      "file": "api/listrule/index.md",
      "searchText": "operationId listRule summary List all rules. description List all rules. method get path /v1/rules tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rules content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrule/index.md"
        }
      ]
    },
    {
      "id": "api/storerule/index.md",
      "kind": "operation",
      "title": "Store a new rule",
      "description": "Creates a new rule. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storerule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storerule/index.md",
      "file": "api/storerule/index.md",
      "searchText": "operationId storeRule summary Store a new rule description Creates a new rule. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/rules tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary rule information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerStore properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionStore properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerStore properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionStore properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New rule stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storerule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storerule/index.md"
        }
      ]
    },
    {
      "id": "api/getrule/index.md",
      "kind": "operation",
      "title": "Get a single rule.",
      "description": "GET /v1/rules/{id}: returns RuleSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getrule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getrule/index.md",
      "file": "api/getrule/index.md",
      "searchText": "operationId getRule summary Get a single rule. description Get a single rule. method get path /v1/rules/{id} tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the object. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested rule content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rules/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getrule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getrule/index.md"
        }
      ]
    },
    {
      "id": "api/updaterule/index.md",
      "kind": "operation",
      "title": "Update existing rule.",
      "description": "PUT /v1/rules/{id}: takes RuleUpdate, returns RuleSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updaterule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updaterule/index.md",
      "file": "api/updaterule/index.md",
      "searchText": "operationId updateRule summary Update existing rule. description Update existing rule. method put path /v1/rules/{id} tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the object. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated rule information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerUpdate properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. If the rule trigger is something like 'has any tag', submit the string 'true'. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionUpdate properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerUpdate properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. If the rule trigger is something like 'has any tag', submit the string 'true'. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionUpdate properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated rule stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/rules/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updaterule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updaterule/index.md"
        }
      ]
    },
    {
      "id": "api/deleterule/index.md",
      "kind": "operation",
      "title": "Delete an rule.",
      "description": "DELETE /v1/rules/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleterule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleterule/index.md",
      "file": "api/deleterule/index.md",
      "searchText": "operationId deleteRule summary Delete an rule. description Delete an rule. method delete path /v1/rules/{id} tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the rule. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Rule deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/rules/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleterule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleterule/index.md"
        }
      ]
    },
    {
      "id": "api/validateactionexpression/index.md",
      "kind": "operation",
      "title": "Validate an action expression.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/validateactionexpression/",
      "markdown": "https://sourcey-firefly.pages.dev/api/validateactionexpression/index.md",
      "file": "api/validateactionexpression/index.md",
      "searchText": "operationId validateActionExpression summary Validate an action expression. description Validate an action expression as used in rule actions. Returns whether the submitted expression is valid.\nIf the expression is invalid, a 422 validation error is returned instead.\n method get path /v1/rules/validate-expression tags 0 rules parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name expression in query description The action expression to validate. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {{ description | upper }} examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The expression is valid. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties valid name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/rules/validate-expression",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/validateactionexpression/",
          "markdown": "https://sourcey-firefly.pages.dev/api/validateactionexpression/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbysubscription/index.md",
      "kind": "operation",
      "title": "List all attachments uploaded to the subscription.",
      "description": "This endpoint will list all attachments linked to the subscription (also known as a bill).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbysubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbysubscription/index.md",
      "file": "api/listattachmentbysubscription/index.md",
      "searchText": "operationId listAttachmentBySubscription summary List all attachments uploaded to the subscription. description This endpoint will list all attachments linked to the subscription (also known as a bill). method get path /v1/subscriptions/{id}/attachments tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/subscriptions/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbysubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbysubscription/index.md"
        }
      ]
    },
    {
      "id": "api/listrulebysubscription/index.md",
      "kind": "operation",
      "title": "List all rules associated with the subscription.",
      "description": "This endpoint will list all rules that have an action to set the subscription (bill) to this subscription.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrulebysubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrulebysubscription/index.md",
      "file": "api/listrulebysubscription/index.md",
      "searchText": "operationId listRuleBySubscription summary List all rules associated with the subscription. description This endpoint will list all rules that have an action to set the subscription (bill) to this subscription. method get path /v1/subscriptions/{id}/rules tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rules content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/subscriptions/{id}/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrulebysubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrulebysubscription/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbysubscription/index.md",
      "kind": "operation",
      "title": "List all transactions associated with the subscription.",
      "description": "This endpoint will list all transactions linked to this subscription (also known as a bill).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbysubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbysubscription/index.md",
      "file": "api/listtransactionbysubscription/index.md",
      "searchText": "operationId listTransactionBySubscription summary List all transactions associated with the subscription. description This endpoint will list all transactions linked to this subscription (also known as a bill). method get path /v1/subscriptions/{id}/transactions tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/subscriptions/{id}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbysubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbysubscription/index.md"
        }
      ]
    },
    {
      "id": "api/listsubscription/index.md",
      "kind": "operation",
      "title": "List all subscriptions.",
      "description": "This endpoint will list all the user's subscriptions. Subscriptions are also known as bills, and this endpoint is an alias of /bills.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listsubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listsubscription/index.md",
      "file": "api/listsubscription/index.md",
      "searchText": "operationId listSubscription summary List all subscriptions. description This endpoint will list all the user's subscriptions. Subscriptions are also known as bills, and this endpoint is an alias of `/bills`. method get path /v1/subscriptions tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of subscriptions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listsubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listsubscription/index.md"
        }
      ]
    },
    {
      "id": "api/storesubscription/index.md",
      "kind": "operation",
      "title": "Store a new subscription",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storesubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storesubscription/index.md",
      "file": "api/storesubscription/index.md",
      "searchText": "operationId storeSubscription summary Store a new subscription description 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. method post path /v1/subscriptions tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary subscription information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillStore properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 amount_min 2 amount_max 3 date 4 repeat_freq example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillStore properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 amount_min 2 amount_max 3 date 4 repeat_freq example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New subscription stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/subscriptions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storesubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storesubscription/index.md"
        }
      ]
    },
    {
      "id": "api/getsubscription/index.md",
      "kind": "operation",
      "title": "Get a single subscription.",
      "description": "Get a single subscription. Subscriptions are also known as bills.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getsubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getsubscription/index.md",
      "file": "api/getsubscription/index.md",
      "searchText": "operationId getSubscription summary Get a single subscription. description Get a single subscription. Subscriptions are also known as bills. method get path /v1/subscriptions/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name start in query description A date formatted YYYY-MM-DD. If it is are added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name end in query description A date formatted YYYY-MM-DD. If it is added to the request, Firefly III will calculate the appropriate payment and paid dates.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested subscription content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/subscriptions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getsubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getsubscription/index.md"
        }
      ]
    },
    {
      "id": "api/updatesubscription/index.md",
      "kind": "operation",
      "title": "Update existing subscription.",
      "description": "PUT /v1/subscriptions/{id}: takes BillUpdate, returns BillSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatesubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatesubscription/index.md",
      "file": "api/updatesubscription/index.md",
      "searchText": "operationId updateSubscription summary Update existing subscription. description Update existing subscription. method put path /v1/subscriptions/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array or key=value pairs with updated subscription information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillUpdate properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillUpdate properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated subscription stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/subscriptions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatesubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatesubscription/index.md"
        }
      ]
    },
    {
      "id": "api/deletesubscription/index.md",
      "kind": "operation",
      "title": "Delete a subscription.",
      "description": "Delete a subscription. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletesubscription/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletesubscription/index.md",
      "file": "api/deletesubscription/index.md",
      "searchText": "operationId deleteSubscription summary Delete a subscription. description Delete a subscription. This will not delete any associated rules. Will not remove associated transactions. WILL remove all associated attachments. method delete path /v1/subscriptions/{id} tags 0 bills parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the subscription. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Subscription deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/subscriptions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletesubscription/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletesubscription/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbytag/index.md",
      "kind": "operation",
      "title": "Lists all attachments.",
      "description": "GET /v1/tags/{tag}/attachments: returns AttachmentArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbytag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbytag/index.md",
      "file": "api/listattachmentbytag/index.md",
      "searchText": "operationId listAttachmentByTag summary Lists all attachments. description Lists all attachments. method get path /v1/tags/{tag}/attachments tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name tag in path description Either the tag itself or the tag ID. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/tags/{tag}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbytag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbytag/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbytag/index.md",
      "kind": "operation",
      "title": "List all transactions with this tag.",
      "description": "GET /v1/tags/{tag}/transactions: returns TransactionArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbytag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbytag/index.md",
      "file": "api/listtransactionbytag/index.md",
      "searchText": "operationId listTransactionByTag summary List all transactions with this tag. description List all transactions with this tag. method get path /v1/tags/{tag}/transactions tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name tag in path description Either the tag itself or the tag ID. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive).\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/tags/{tag}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbytag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbytag/index.md"
        }
      ]
    },
    {
      "id": "api/listtag/index.md",
      "kind": "operation",
      "title": "List all tags.",
      "description": "List all of the user's tags.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtag/index.md",
      "file": "api/listtag/index.md",
      "searchText": "operationId listTag summary List all tags. description List all of the user's tags. method get path /v1/tags tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of tags content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/tags",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtag/index.md"
        }
      ]
    },
    {
      "id": "api/storetag/index.md",
      "kind": "operation",
      "title": "Store a new tag",
      "description": "Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storetag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storetag/index.md",
      "file": "api/storetag/index.md",
      "searchText": "operationId storeTag summary Store a new tag description Creates a new tag. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/tags tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary tag information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single tag (A) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelStore properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single tag (A) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelStore properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New tag stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/tags",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storetag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storetag/index.md"
        }
      ]
    },
    {
      "id": "api/gettag/index.md",
      "kind": "operation",
      "title": "Get a single tag.",
      "description": "GET /v1/tags/{tag}: returns TagSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettag/index.md",
      "file": "api/gettag/index.md",
      "searchText": "operationId getTag summary Get a single tag. description Get a single tag. method get path /v1/tags/{tag} tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name tag in path description Either the tag itself or the tag ID. If you use the tag itself, and it contains international (non-ASCII) characters, your mileage may vary. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested tag content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/tags/{tag}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettag/index.md"
        }
      ]
    },
    {
      "id": "api/updatetag/index.md",
      "kind": "operation",
      "title": "Update existing tag.",
      "description": "PUT /v1/tags/{tag}: takes TagModelUpdate, returns TagSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatetag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatetag/index.md",
      "file": "api/updatetag/index.md",
      "searchText": "operationId updateTag summary Update existing tag. description Update existing tag. method put path /v1/tags/{tag} tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name tag in path description Either the tag itself or the tag ID. If you use the tag itself, and it contains international (non-ASCII) characters, your mileage may vary. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  requestBody description JSON array with updated tag information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single tag (B) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelUpdate properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single tag (B) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelUpdate properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated tag stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/tags/{tag}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatetag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatetag/index.md"
        }
      ]
    },
    {
      "id": "api/deletetag/index.md",
      "kind": "operation",
      "title": "Delete an tag.",
      "description": "DELETE /v1/tags/{tag}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletetag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletetag/index.md",
      "file": "api/deletetag/index.md",
      "searchText": "operationId deleteTag summary Delete an tag. description Delete an tag. method delete path /v1/tags/{tag} tags 0 tags parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name tag in path description Either the tag itself or the tag ID. If you use the tag itself, and it contains international (non-ASCII) characters, your mileage may vary. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Tag deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/tags/{tag}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletetag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletetag/index.md"
        }
      ]
    },
    {
      "id": "api/listaccountbycurrency/index.md",
      "kind": "operation",
      "title": "List all accounts with this currency.",
      "description": "GET /v1/currencies/{code}/accounts: returns AccountArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listaccountbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listaccountbycurrency/index.md",
      "file": "api/listaccountbycurrency/index.md",
      "searchText": "operationId listAccountByCurrency summary List all accounts with this currency. description List all accounts with this currency. method get path /v1/currencies/{code}/accounts tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  4 name date in query description A date formatted YYYY-MM-DD. When added to the request, Firefly III will show the account's balance on that day.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  5 name type in query description Optional filter on the account type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 asset 2 cash 3 expense 4 revenue 5 special 6 hidden 7 liability 8 liabilities 9 Default account 10 Cash account 11 Asset account 12 Expense account 13 Revenue account 14 Initial balance account 15 Beneficiary account 16 Import account 17 Reconciliation account 18 Loan 19 Debt 20 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of accounts content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listaccountbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listaccountbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listavailablebudgetbycurrency/index.md",
      "kind": "operation",
      "title": "List all available budgets with this currency.",
      "description": "GET /v1/currencies/{code}/available-budgets: returns AvailableBudgetArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listavailablebudgetbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listavailablebudgetbycurrency/index.md",
      "file": "api/listavailablebudgetbycurrency/index.md",
      "searchText": "operationId listAvailableBudgetByCurrency summary List all available budgets with this currency. description List all available budgets with this currency. method get path /v1/currencies/{code}/available-budgets tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of available budgets content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/available-budgets",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listavailablebudgetbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listavailablebudgetbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listbillbycurrency/index.md",
      "kind": "operation",
      "title": "List all bills with this currency.",
      "description": "GET /v1/currencies/{code}/bills: returns BillArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbillbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbillbycurrency/index.md",
      "file": "api/listbillbycurrency/index.md",
      "searchText": "operationId listBillByCurrency summary List all bills with this currency. description List all bills with this currency. method get path /v1/currencies/{code}/bills tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of bills. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/bills",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbillbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbillbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listbudgetlimitbycurrency/index.md",
      "kind": "operation",
      "title": "List all budget limits with this currency",
      "description": "GET /v1/currencies/{code}/budget-limits: returns BudgetLimitArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbycurrency/index.md",
      "file": "api/listbudgetlimitbycurrency/index.md",
      "searchText": "operationId listBudgetLimitByCurrency summary List all budget limits with this currency description List all budget limits with this currency method get path /v1/currencies/{code}/budget-limits tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  4 name start in query description Start date for the budget limit list. required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description End date for the budget limit list. required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of budget limits. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/budget-limits",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listbudgetlimitbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listrecurrencebycurrency/index.md",
      "kind": "operation",
      "title": "List all recurring transactions with this currency.",
      "description": "GET /v1/currencies/{code}/recurrences: returns RecurrenceArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrecurrencebycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrecurrencebycurrency/index.md",
      "file": "api/listrecurrencebycurrency/index.md",
      "searchText": "operationId listRecurrenceByCurrency summary List all recurring transactions with this currency. description List all recurring transactions with this currency. method get path /v1/currencies/{code}/recurrences tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of recurring transactions content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/recurrences",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrecurrencebycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrecurrencebycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listrulebycurrency/index.md",
      "kind": "operation",
      "title": "List all rules with this currency.",
      "description": "GET /v1/currencies/{code}/rules: returns RuleArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listrulebycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listrulebycurrency/index.md",
      "file": "api/listrulebycurrency/index.md",
      "searchText": "operationId listRuleByCurrency summary List all rules with this currency. description List all rules with this currency. method get path /v1/currencies/{code}/rules tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of rules content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/rules",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listrulebycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listrulebycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listtransactionbycurrency/index.md",
      "kind": "operation",
      "title": "List all transactions with this currency.",
      "description": "GET /v1/currencies/{code}/transactions: returns TransactionArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransactionbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbycurrency/index.md",
      "file": "api/listtransactionbycurrency/index.md",
      "searchText": "operationId listTransactionByCurrency summary List all transactions with this currency. description List all transactions with this currency. method get path /v1/currencies/{code}/transactions tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  4 name start in query description A date formatted YYYY-MM-DD, to limit the list of transactions.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  5 name end in query description A date formatted YYYY-MM-DD, to limit the list of transactions.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  6 name type in query description Optional filter on the transaction type(s) returned required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransactionbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransactionbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listexchangeratesbycurrency/index.md",
      "kind": "operation",
      "title": "List all exchange rates for this currency.",
      "description": "List all currency exchange rates that have this currency as the source or destination currency.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listexchangeratesbycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listexchangeratesbycurrency/index.md",
      "file": "api/listexchangeratesbycurrency/index.md",
      "searchText": "operationId listExchangeRatesByCurrency summary List all exchange rates for this currency. description List all currency exchange rates that have this currency as the source or destination currency. method get path /v1/currencies/{code}/cer tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of currency exchange rates. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}/cer",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listexchangeratesbycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listexchangeratesbycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listcurrency/index.md",
      "kind": "operation",
      "title": "List all currencies.",
      "description": "GET /v1/currencies: returns CurrencyArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listcurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listcurrency/index.md",
      "file": "api/listcurrency/index.md",
      "searchText": "operationId listCurrency summary List all currencies. description List all currencies. method get path /v1/currencies tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of currencies. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listcurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listcurrency/index.md"
        }
      ]
    },
    {
      "id": "api/storecurrency/index.md",
      "kind": "operation",
      "title": "Store a new currency",
      "description": "Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storecurrency/index.md",
      "file": "api/storecurrency/index.md",
      "searchText": "operationId storeCurrency summary Store a new currency description Creates a new currency. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/currencies tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary currency information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyStore properties enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Make this currency the primary currency for the current administration. You can set this value to FALSE, in which case nothing will change to the primary currency. If you set it to TRUE, the current primary currency will no longer be the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyStore properties enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Make this currency the primary currency for the current administration. You can set this value to FALSE, in which case nothing will change to the primary currency. If you set it to TRUE, the current primary currency will no longer be the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New currency stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/currencies",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/enablecurrency/index.md",
      "kind": "operation",
      "title": "Enable a single currency.",
      "description": "POST /v1/currencies/{code}/enable: returns CurrencySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/enablecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/enablecurrency/index.md",
      "file": "api/enablecurrency/index.md",
      "searchText": "operationId enableCurrency summary Enable a single currency. description Enable a single currency. method post path /v1/currencies/{code}/enable tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency was enabled. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/currencies/{code}/enable",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/enablecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/enablecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/disablecurrency/index.md",
      "kind": "operation",
      "title": "Disable a currency.",
      "description": "POST /v1/currencies/{code}/disable: returns CurrencySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/disablecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/disablecurrency/index.md",
      "file": "api/disablecurrency/index.md",
      "searchText": "operationId disableCurrency summary Disable a currency. description Disable a currency. method post path /v1/currencies/{code}/disable tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency was disabled. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 409 summary  description Currency cannot be disabled, because it is still in use. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/currencies/{code}/disable",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/disablecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/disablecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/primarycurrency/index.md",
      "kind": "operation",
      "title": "Make currency primary currency.",
      "description": "Make this currency the primary currency for the current financial administration. If the currency is not enabled, it will be enabled as well.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/primarycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/primarycurrency/index.md",
      "file": "api/primarycurrency/index.md",
      "searchText": "operationId primaryCurrency summary Make currency primary currency. description Make this currency the primary currency for the current financial administration. If the currency is not enabled, it will be enabled as well. method post path /v1/currencies/{code}/primary tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency has been made the primary currency. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/currencies/{code}/primary",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/primarycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/primarycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/getcurrency/index.md",
      "kind": "operation",
      "title": "Get a single currency.",
      "description": "GET /v1/currencies/{code}: returns CurrencySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcurrency/index.md",
      "file": "api/getcurrency/index.md",
      "searchText": "operationId getCurrency summary Get a single currency. description Get a single currency. method get path /v1/currencies/{code} tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested currency content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/{code}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcurrency/index.md"
        }
      ]
    },
    {
      "id": "api/updatecurrency/index.md",
      "kind": "operation",
      "title": "Update existing currency.",
      "description": "PUT /v1/currencies/{code}: takes CurrencyUpdate, returns CurrencySingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrency/index.md",
      "file": "api/updatecurrency/index.md",
      "searchText": "operationId updateCurrency summary Update existing currency. description Update existing currency. method put path /v1/currencies/{code} tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  content  example  examples  requestBody description JSON array with updated currency information. See the model for the exact specifications. required  content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyUpdate properties enabled name  type boolean format  title  description If the currency is enabled default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description If the currency must be the primary for the user. You can only submit TRUE. Submitting FALSE will not drop this currency as the primary currency, because then the system would be without one. default  enum 0  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description The currency code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description The currency name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description The currency symbol default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description How many decimals to use when displaying this currency. Between 0 and 16. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyUpdate properties enabled name  type boolean format  title  description If the currency is enabled default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description If the currency must be the primary for the user. You can only submit TRUE. Submitting FALSE will not drop this currency as the primary currency, because then the system would be without one. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description The currency code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description The currency name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description The currency symbol default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description How many decimals to use when displaying this currency. Between 0 and 16. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated currency stored, result in response content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/currencies/{code}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/deletecurrency/index.md",
      "kind": "operation",
      "title": "Delete a currency.",
      "description": "DELETE /v1/currencies/{code}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletecurrency/index.md",
      "file": "api/deletecurrency/index.md",
      "searchText": "operationId deleteCurrency summary Delete a currency. description Delete a currency. method delete path /v1/currencies/{code} tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name code in path description The currency code. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Currency deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/currencies/{code}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/getprimarycurrency/index.md",
      "kind": "operation",
      "title": "Get the primary currency of the current administration.",
      "description": "Get the primary currency of the current administration. This replaces what was called \"the user's default currency\" although they are essentially the same.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getprimarycurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getprimarycurrency/index.md",
      "file": "api/getprimarycurrency/index.md",
      "searchText": "operationId getPrimaryCurrency summary Get the primary currency of the current administration. description Get the primary currency of the current administration. This replaces what was called \"the user's default currency\" although they are essentially the same. method get path /v1/currencies/primary tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 200 summary  description The primary currency content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/primary",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getprimarycurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getprimarycurrency/index.md"
        }
      ]
    },
    {
      "id": "api/getdefaultcurrency/index.md",
      "kind": "operation",
      "title": "Get the default (primary) currency of the current administration.",
      "description": "Get the default currency of the current administration. This is an alias of /currencies/primary.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getdefaultcurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getdefaultcurrency/index.md",
      "file": "api/getdefaultcurrency/index.md",
      "searchText": "operationId getDefaultCurrency summary Get the default (primary) currency of the current administration. description Get the default currency of the current administration. This is an alias of `/currencies/primary`. method get path /v1/currencies/default tags 0 currencies parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 200 summary  description The default currency content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/currencies/default",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getdefaultcurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getdefaultcurrency/index.md"
        }
      ]
    },
    {
      "id": "api/listlinksbyjournal/index.md",
      "kind": "operation",
      "title": "Lists all the transaction links for an individual journal (individual split).",
      "description": "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).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listlinksbyjournal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listlinksbyjournal/index.md",
      "file": "api/listlinksbyjournal/index.md",
      "searchText": "operationId listLinksByJournal summary Lists all the transaction links for an individual journal (individual split). description 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). method get path /v1/transaction-journals/{id}/links tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the transaction journal / the split. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transaction links. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transaction-journals/{id}/links",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listlinksbyjournal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listlinksbyjournal/index.md"
        }
      ]
    },
    {
      "id": "api/gettransactionbyjournal/index.md",
      "kind": "operation",
      "title": "Get a single transaction, based on one of the underlying transaction journals (transaction splits).",
      "description": "Get a single transaction by underlying journal (split).",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransactionbyjournal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionbyjournal/index.md",
      "file": "api/gettransactionbyjournal/index.md",
      "searchText": "operationId getTransactionByJournal summary Get a single transaction, based on one of the underlying transaction journals (transaction splits). description Get a single transaction by underlying journal (split). method get path /v1/transaction-journals/{id} tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction journal (split). required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested transaction. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transaction-journals/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransactionbyjournal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransactionbyjournal/index.md"
        }
      ]
    },
    {
      "id": "api/deletetransactionjournal/index.md",
      "kind": "operation",
      "title": "Delete split from transaction",
      "description": "Delete an individual journal (split) from a transaction.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletetransactionjournal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletetransactionjournal/index.md",
      "file": "api/deletetransactionjournal/index.md",
      "searchText": "operationId deleteTransactionJournal summary Delete split from transaction description Delete an individual journal (split) from a transaction. method delete path /v1/transaction-journals/{id} tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction journal (the split) you wish to delete. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Transaction journal (split) deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/transaction-journals/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletetransactionjournal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletetransactionjournal/index.md"
        }
      ]
    },
    {
      "id": "api/listattachmentbytransaction/index.md",
      "kind": "operation",
      "title": "Lists all attachments.",
      "description": "GET /v1/transactions/{id}/attachments: returns AttachmentArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listattachmentbytransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbytransaction/index.md",
      "file": "api/listattachmentbytransaction/index.md",
      "searchText": "operationId listAttachmentByTransaction summary Lists all attachments. description Lists all attachments. method get path /v1/transactions/{id}/attachments tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of attachments content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transactions/{id}/attachments",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listattachmentbytransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listattachmentbytransaction/index.md"
        }
      ]
    },
    {
      "id": "api/listeventbytransaction/index.md",
      "kind": "operation",
      "title": "Lists all piggy bank events.",
      "description": "GET /v1/transactions/{id}/piggy-bank-events: returns PiggyBankEventArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listeventbytransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listeventbytransaction/index.md",
      "file": "api/listeventbytransaction/index.md",
      "searchText": "operationId listEventByTransaction summary Lists all piggy bank events. description Lists all piggy bank events. method get path /v1/transactions/{id}/piggy-bank-events tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The ID of the transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of piggy bank events. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_bank_events examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_journal_id name  type string format string title  description The journal associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  transaction_group_id name  type string format string title  description The transaction group associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transactions/{id}/piggy-bank-events",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listeventbytransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listeventbytransaction/index.md"
        }
      ]
    },
    {
      "id": "api/listtransaction/index.md",
      "kind": "operation",
      "title": "List all the user's transactions.\n",
      "description": "List all the user's transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listtransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listtransaction/index.md",
      "file": "api/listtransaction/index.md",
      "searchText": "operationId listTransaction summary List all the user's transactions.\n description List all the user's transactions. method get path /v1/transactions tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name start in query description A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive).\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  4 name end in query description A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive).\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  content  example  examples  5 name type in query description Optional filter on the transaction type(s) returned. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listtransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listtransaction/index.md"
        }
      ]
    },
    {
      "id": "api/storetransaction/index.md",
      "kind": "operation",
      "title": "Store a new transaction",
      "description": "Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storetransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storetransaction/index.md",
      "file": "api/storetransaction/index.md",
      "searchText": "operationId storeTransaction summary Store a new transaction description Creates a new transaction. The data required can be submitted as a JSON body or as a list of parameters. method post path /v1/transactions tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary transaction information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionStore properties error_if_duplicate_hash name  type boolean format  title  description Break if the submitted transaction exists already. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitStore properties type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_id name  type integer format int32 title  description Optional. Use either this or the piggy_bank_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_name name  type string format string title  description Optional. Use either this or the piggy_bank_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 112 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 date 2 description 3 type required 0 transactions example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionStore properties error_if_duplicate_hash name  type boolean format  title  description Break if the submitted transaction exists already. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitStore properties type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_id name  type integer format int32 title  description Optional. Use either this or the piggy_bank_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_name name  type string format string title  description Optional. Use either this or the piggy_bank_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 112 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 date 2 description 3 type required 0 transactions example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New transaction stored(s), result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storetransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storetransaction/index.md"
        }
      ]
    },
    {
      "id": "api/gettransaction/index.md",
      "kind": "operation",
      "title": "Get a single transaction.",
      "description": "GET /v1/transactions/{id}: returns TransactionSingle.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/gettransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/gettransaction/index.md",
      "file": "api/gettransaction/index.md",
      "searchText": "operationId getTransaction summary Get a single transaction. description Get a single transaction. method get path /v1/transactions/{id} tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested transaction. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/transactions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/gettransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/gettransaction/index.md"
        }
      ]
    },
    {
      "id": "api/updatetransaction/index.md",
      "kind": "operation",
      "title": "Update existing transaction",
      "description": "Update an existing transaction. For more information, see Transaction update.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatetransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatetransaction/index.md",
      "file": "api/updatetransaction/index.md",
      "searchText": "operationId updateTransaction summary Update existing transaction description Update an existing transaction. For more information, see [Transaction update](/references/firefly-iii/api/specials/#transaction-update). method put path /v1/transactions/{id} tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated transaction information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionUpdate properties apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitUpdate properties transaction_journal_id name  type string format string title  description Transaction journal ID of current transaction (split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionUpdate properties apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitUpdate properties transaction_journal_id name  type string format string title  description Transaction journal ID of current transaction (split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated transaction stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/transactions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatetransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatetransaction/index.md"
        }
      ]
    },
    {
      "id": "api/deletetransaction/index.md",
      "kind": "operation",
      "title": "Delete a transaction.",
      "description": "DELETE /v1/transactions/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletetransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletetransaction/index.md",
      "file": "api/deletetransaction/index.md",
      "searchText": "operationId deleteTransaction summary Delete a transaction. description Delete a transaction. method delete path /v1/transactions/{id} tags 0 transactions parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the transaction. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Transaction deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/transactions/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletetransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletetransaction/index.md"
        }
      ]
    },
    {
      "id": "api/listusergroups/index.md",
      "kind": "operation",
      "title": "List all the user groups available to this user.\n",
      "description": "List all the user groups available to this user. These are essentially the 'financial administrations' that Firefly III supports.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listusergroups/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listusergroups/index.md",
      "file": "api/listusergroups/index.md",
      "searchText": "operationId listUserGroups summary List all the user groups available to this user.\n description List all the user groups available to this user. These are essentially the 'financial administrations' that Firefly III supports. method get path /v1/user-groups tags 0 user_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of user groups. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/user-groups",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listusergroups/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listusergroups/index.md"
        }
      ]
    },
    {
      "id": "api/getusergroup/index.md",
      "kind": "operation",
      "title": "Get a single user group.",
      "description": "Returns a single user group by its ID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getusergroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getusergroup/index.md",
      "file": "api/getusergroup/index.md",
      "searchText": "operationId getUserGroup summary Get a single user group. description Returns a single user group by its ID.\n method get path /v1/user-groups/{id} tags 0 user_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the user group. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested user group content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/user-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getusergroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getusergroup/index.md"
        }
      ]
    },
    {
      "id": "api/updateusergroup/index.md",
      "kind": "operation",
      "title": "Update an existing user group.",
      "description": "Used to update a single user group. The available fields are still limited.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updateusergroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updateusergroup/index.md",
      "file": "api/updateusergroup/index.md",
      "searchText": "operationId updateUserGroup summary Update an existing user group. description Used to update a single user group. The available fields are still limited.\n method put path /v1/user-groups/{id} tags 0 user_groups parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The ID of the account. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody description JSON array or form-data with new user group information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupUpdate properties title name  type string format string title  description A descriptive title for the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New user group title examples  refName  primary_currency_id name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  primary_currency_code name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupUpdate properties title name  type string format string title  description A descriptive title for the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New user group title examples  refName  primary_currency_id name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  primary_currency_code name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 title example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated user group is stored, result is in the response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/user-groups/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updateusergroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updateusergroup/index.md"
        }
      ]
    },
    {
      "id": "api/searchaccounts/index.md",
      "kind": "operation",
      "title": "Search for accounts",
      "description": "GET /v1/search/accounts: returns AccountArray.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/searchaccounts/",
      "markdown": "https://sourcey-firefly.pages.dev/api/searchaccounts/index.md",
      "file": "api/searchaccounts/index.md",
      "searchText": "operationId searchAccounts summary Search for accounts description Search for accounts method get path /v1/search/accounts tags 0 search parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name query in query description The query you wish to search for. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example checking examples  refName  content  example  examples  4 name type in query description The type of accounts you wish to limit the search to. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 asset 2 cash 3 expense 4 revenue 5 special 6 hidden 7 liability 8 liabilities 9 Default account 10 Cash account 11 Asset account 12 Expense account 13 Revenue account 14 Initial balance account 15 Beneficiary account 16 Import account 17 Reconciliation account 18 Loan 19 Debt 20 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountTypeFilter content  example  examples  5 name field in query description The account field(s) you want to search in. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 all 1 iban 2 name 3 number 4 id enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSearchFieldFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of accounts. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/search/accounts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/searchaccounts/",
          "markdown": "https://sourcey-firefly.pages.dev/api/searchaccounts/index.md"
        }
      ]
    },
    {
      "id": "api/searchtransactions/index.md",
      "kind": "operation",
      "title": "Search for transactions",
      "description": "Searches through the users transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/searchtransactions/",
      "markdown": "https://sourcey-firefly.pages.dev/api/searchtransactions/index.md",
      "file": "api/searchtransactions/index.md",
      "searchText": "operationId searchTransactions summary Search for transactions description Searches through the users transactions. method get path /v1/search/transactions tags 0 search parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name query in query description The query you wish to search for. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of transactions. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs url /how-to/firefly-iii/features/search/ description Search Documentation callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/search/transactions",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/searchtransactions/",
          "markdown": "https://sourcey-firefly.pages.dev/api/searchtransactions/index.md"
        }
      ]
    },
    {
      "id": "api/counttransactions/index.md",
      "kind": "operation",
      "title": "Count transactions matching the given filters.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/counttransactions/",
      "markdown": "https://sourcey-firefly.pages.dev/api/counttransactions/index.md",
      "file": "api/counttransactions/index.md",
      "searchText": "operationId countTransactions summary Count transactions matching the given filters. description Returns the number of transactions that match the given meta-field filters. This is useful to check for\nexisting transactions (for example to avoid duplicates) before storing new data.\n method get path /v1/search/transactions/count tags 0 search parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name external_identifier in query description Count transactions with this exact external identifier. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example abcd-1234 examples  refName  content  example  examples  2 name internal_reference in query description Count transactions with this exact internal reference. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example INV-998 examples  refName  content  example  examples  3 name notes in query description Count transactions whose notes contain this string. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example groceries examples  refName  content  example  examples  4 name description in query description Count transactions with this exact description. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  content  example  examples  5 name include_deleted in query description Whether to include soft-deleted transactions in the count. required  deprecated  style  explode  allowReserved  schema name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The number of matching transactions. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 42 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/search/transactions/count",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/counttransactions/",
          "markdown": "https://sourcey-firefly.pages.dev/api/counttransactions/index.md"
        }
      ]
    },
    {
      "id": "api/getbasicsummary/index.md",
      "kind": "operation",
      "title": "Returns basic sums of the users data.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getbasicsummary/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getbasicsummary/index.md",
      "file": "api/getbasicsummary/index.md",
      "searchText": "operationId getBasicSummary summary Returns basic sums of the users data. description 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.\n method get path /v1/summary/basic tags 0 summary parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name start in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  2 name end in query description A date formatted YYYY-MM-DD.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  3 name currency_code in query description A currency code like EUR or USD, to filter the result.\n required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description An array of sums. It depends on the user what you can expect to get back, so please try this out on the demo site. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BasicSummary additionalProperties name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BasicSummaryEntry properties key name  type string format string title  description This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example balance-in-EUR examples  refName  title name  type string format string title  description A translated title for the information shared. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Balance ($) examples  refName  monetary_value name  type number format double title  description The amount as a float. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals for the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  no_available_budgets name  type boolean format  title  description True if there are no available budgets available. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  value_parsed name  type string format string title  description The amount formatted according to the users locale default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ 12.45 examples  refName  sub_title name  type string format string title  description A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $20 + $-40 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/summary/basic",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getbasicsummary/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getbasicsummary/index.md"
        }
      ]
    },
    {
      "id": "api/getabout/index.md",
      "kind": "operation",
      "title": "System information end point.",
      "description": "Returns general system information and versions of the (supporting) software.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getabout/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getabout/index.md",
      "file": "api/getabout/index.md",
      "searchText": "operationId getAbout summary System information end point. description Returns general system information and versions of the (supporting) software.\n method get path /v1/about tags 0 about parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 200 summary  description The available system information content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName SystemInfo properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  api_version name  type string format string title  description Same value as the version field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  php_version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 8.1.5 examples  refName  os name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Linux examples  refName  driver name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example mysql examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/about",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getabout/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getabout/index.md"
        }
      ]
    },
    {
      "id": "api/getcurrentuser/index.md",
      "kind": "operation",
      "title": "Currently authenticated user endpoint.",
      "description": "Returns the currently authenticated user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcurrentuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcurrentuser/index.md",
      "file": "api/getcurrentuser/index.md",
      "searchText": "operationId getCurrentUser summary Currently authenticated user endpoint. description Returns the currently authenticated user.\n method get path /v1/about/user tags 0 about parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 200 summary  description The user content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/about/user",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcurrentuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcurrentuser/index.md"
        }
      ]
    },
    {
      "id": "api/getreleasenotes/index.md",
      "kind": "operation",
      "title": "Release notes endpoint.",
      "description": "Returns the release notes for a specific version of Firefly III.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getreleasenotes/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getreleasenotes/index.md",
      "file": "api/getreleasenotes/index.md",
      "searchText": "operationId getReleaseNotes summary Release notes endpoint. description Returns the release notes for a specific version of Firefly III.\n method get path /v1/release-notes/{version} tags 0 about parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name version in path description The version of the release notes to retrieve. Also possible is \"v6.7.8\" or \"develop-2026-10-12\". Notice the dash instead of the forward slash. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.8.0 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The release notes for the specified version. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ReleaseNotes properties version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  release_notes name  type string format string title  description The release notes as HTML. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  release_notes_markdown name  type string format string title  description The release notes in Markdown format. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/release-notes/{version}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getreleasenotes/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getreleasenotes/index.md"
        }
      ]
    },
    {
      "id": "api/finishbatch/index.md",
      "kind": "operation",
      "title": "Finish a batch of unprocessed transactions.",
      "description": "summary: Finish a batch of unprocessed transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/finishbatch/",
      "markdown": "https://sourcey-firefly.pages.dev/api/finishbatch/index.md",
      "file": "api/finishbatch/index.md",
      "searchText": "operationId finishBatch summary Finish a batch of unprocessed transactions. description summary: Finish a batch of unprocessed transactions.\n method post path /v1/batch/finish tags 0 about parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 204 summary  description Empty response when the update was successful. A future improvement is to include the changed transactions. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/batch/finish",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/finishbatch/",
          "markdown": "https://sourcey-firefly.pages.dev/api/finishbatch/index.md"
        }
      ]
    },
    {
      "id": "api/getconfiguration/index.md",
      "kind": "operation",
      "title": "Get Firefly III system configuration values.",
      "description": "Returns all editable and not-editable configuration values for this Firefly III installation",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getconfiguration/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getconfiguration/index.md",
      "file": "api/getconfiguration/index.md",
      "searchText": "operationId getConfiguration summary Get Firefly III system configuration values. description Returns all editable and not-editable configuration values for this Firefly III installation method get path /v1/configuration tags 0 configuration parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody  responses 0 statusCode 200 summary  description System configuration values content application/x-www-form-urlencoded schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable example  examples  encoding  prefixEncoding  itemEncoding  application/json schema name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/configuration",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getconfiguration/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getconfiguration/index.md"
        }
      ]
    },
    {
      "id": "api/getsingleconfiguration/index.md",
      "kind": "operation",
      "title": "Get a single Firefly III system configuration value",
      "description": "Returns one configuration variable for this Firefly III installation",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getsingleconfiguration/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getsingleconfiguration/index.md",
      "file": "api/getsingleconfiguration/index.md",
      "searchText": "operationId getSingleConfiguration summary Get a single Firefly III system configuration value description Returns one configuration variable for this Firefly III installation method get path /v1/configuration/{name} tags 0 configuration parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name name in path description The name of the configuration value you want to know. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter content  example  examples  requestBody  responses 0 statusCode 200 summary  description One system configuration value content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/configuration/{name}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getsingleconfiguration/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getsingleconfiguration/index.md"
        }
      ]
    },
    {
      "id": "api/setconfiguration/index.md",
      "kind": "operation",
      "title": "Update configuration value",
      "description": "Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/setconfiguration/",
      "markdown": "https://sourcey-firefly.pages.dev/api/setconfiguration/index.md",
      "file": "api/setconfiguration/index.md",
      "searchText": "operationId setConfiguration summary Update configuration value description Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small. method put path /v1/configuration/{name} tags 0 configuration parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name name in path description The name of the configuration value you want to update. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 configuration.enable_exchange_rates 5 configuration.use_running_balance 6 configuration.enable_external_map 7 configuration.enable_external_rates 8 configuration.allow_webhooks 9 configuration.valid_url_protocols enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigValueUpdateFilter content  example  examples  requestBody description JSON array with the necessary account information or key=value pairs. See the model for the exact specifications. required  content application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationUpdate properties value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 value example  examples  encoding  prefixEncoding  itemEncoding  application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationUpdate properties value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 value example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New configuration value stored, result in response. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/configuration/{name}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/setconfiguration/",
          "markdown": "https://sourcey-firefly.pages.dev/api/setconfiguration/index.md"
        }
      ]
    },
    {
      "id": "api/getcron/index.md",
      "kind": "operation",
      "title": "Cron job endpoint",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getcron/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getcron/index.md",
      "file": "api/getcron/index.md",
      "searchText": "operationId getCron summary Cron job endpoint description Firefly III has one endpoint for its various cron related tasks. Send a GET to this endpoint\nto run the cron. The cron requires the CLI token to be present. The cron job will fire for all\nusers.\n method get path /v1/cron/{cliToken} tags 0 about parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name cliToken in path description The CLI token of any user in Firefly III, required to run the cron job. OR this is the `STATIC_CRON_TOKEN`. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example d5ea6b5fb774618dd6ad6ba6e0a7f55c examples  refName  content  example  examples  2 name date in query description A date formatted YYYY-MM-DD. This can be used to make the cron job pretend it's running\non another day.\n required  deprecated  style  explode  allowReserved  schema name  type string format date title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  content  example  examples  3 name force in query description Forces the cron job to fire, regardless of whether it has fired before. This may result\nin double transactions or weird budgets, so be careful. Only system owners can do this.\n required  deprecated  style  explode  allowReserved  schema name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The result of the cron job(s) firing. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResult properties recurring_transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  auto_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  exchange_rates name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  bill_notifications name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  webhooks name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/cron/{cliToken}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getcron/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getcron/index.md"
        }
      ]
    },
    {
      "id": "api/listuser/index.md",
      "kind": "operation",
      "title": "List all users.",
      "description": "List all the users in this instance of Firefly III.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listuser/index.md",
      "file": "api/listuser/index.md",
      "searchText": "operationId listUser summary List all users. description List all the users in this instance of Firefly III. method get path /v1/users tags 0 users parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of users. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/users",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listuser/index.md"
        }
      ]
    },
    {
      "id": "api/storeuser/index.md",
      "kind": "operation",
      "title": "Store a new user",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storeuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storeuser/index.md",
      "file": "api/storeuser/index.md",
      "searchText": "operationId storeUser summary Store a new user description 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.\n method post path /v1/users tags 0 users parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary user information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New user stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/users",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storeuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storeuser/index.md"
        }
      ]
    },
    {
      "id": "api/getuser/index.md",
      "kind": "operation",
      "title": "Get a single user.",
      "description": "Gets all info of a single user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getuser/index.md",
      "file": "api/getuser/index.md",
      "searchText": "operationId getUser summary Get a single user. description Gets all info of a single user. method get path /v1/users/{id} tags 0 users parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The user ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description The requested user. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/users/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getuser/index.md"
        }
      ]
    },
    {
      "id": "api/updateuser/index.md",
      "kind": "operation",
      "title": "Update an existing user's information.",
      "description": "Update existing user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updateuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updateuser/index.md",
      "file": "api/updateuser/index.md",
      "searchText": "operationId updateUser summary Update an existing user's information. description Update existing user. method put path /v1/users/{id} tags 0 users parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The user ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody description JSON array with updated user information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated user stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/users/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updateuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updateuser/index.md"
        }
      ]
    },
    {
      "id": "api/deleteuser/index.md",
      "kind": "operation",
      "title": "Delete a user.",
      "description": "Delete a user. You cannot delete the user you're authenticated with. This cannot be undone. Be careful.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deleteuser/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deleteuser/index.md",
      "file": "api/deleteuser/index.md",
      "searchText": "operationId deleteUser summary Delete a user. description Delete a user. You cannot delete the user you're authenticated with. This cannot be undone. Be careful. method delete path /v1/users/{id} tags 0 users parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The user ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description User deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/users/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deleteuser/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deleteuser/index.md"
        }
      ]
    },
    {
      "id": "api/listpreference/index.md",
      "kind": "operation",
      "title": "List all users preferences.",
      "description": "List all of the preferences of the user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listpreference/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listpreference/index.md",
      "file": "api/listpreference/index.md",
      "searchText": "operationId listPreference summary List all users preferences. description List all of the preferences of the user. method get path /v1/preferences tags 0 preferences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of preferences. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/preferences",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listpreference/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listpreference/index.md"
        }
      ]
    },
    {
      "id": "api/storepreference/index.md",
      "kind": "operation",
      "title": "Store a new preference for this user.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storepreference/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storepreference/index.md",
      "file": "api/storepreference/index.md",
      "searchText": "operationId storePreference summary Store a new preference for this user. description 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. method post path /v1/preferences tags 0 preferences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array with the necessary preference information or key=value pairs. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New account stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/preferences",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storepreference/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storepreference/index.md"
        }
      ]
    },
    {
      "id": "api/getpreference/index.md",
      "kind": "operation",
      "title": "Return a single preference.",
      "description": "Return a single preference and the value.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getpreference/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getpreference/index.md",
      "file": "api/getpreference/index.md",
      "searchText": "operationId getPreference summary Return a single preference. description Return a single preference and the value. method get path /v1/preferences/{name} tags 0 preferences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name name in path description The name of the preference. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A single preference. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/preferences/{name}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getpreference/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getpreference/index.md"
        }
      ]
    },
    {
      "id": "api/updatepreference/index.md",
      "kind": "operation",
      "title": "Update preference",
      "description": "Update a user's preference.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatepreference/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatepreference/index.md",
      "file": "api/updatepreference/index.md",
      "searchText": "operationId updatePreference summary Update preference description Update a user's preference. method put path /v1/preferences/{name} tags 0 preferences parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name name in path description The name of the preference. Will always overwrite. Will be created if it does not exist. required  deprecated  style  explode  allowReserved  schema name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  content  example  examples  requestBody description JSON array or key=value pairs with the necessary preference information. See the model for the exact specifications. required  content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceUpdate properties data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 data example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceUpdate properties data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 data example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated preference. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/preferences/{name}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatepreference/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatepreference/index.md"
        }
      ]
    },
    {
      "id": "api/getwebhookmessages/index.md",
      "kind": "operation",
      "title": "Get all the messages of a single webhook.",
      "description": "When a webhook is triggered the actual message that will be send is stored in a \"message\". You can view and analyse these messages.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getwebhookmessages/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getwebhookmessages/index.md",
      "file": "api/getwebhookmessages/index.md",
      "searchText": "operationId getWebhookMessages summary Get all the messages of a single webhook. description When a webhook is triggered the actual message that will be send is stored in a \"message\". You can view and analyse these messages. method get path /v1/webhooks/{id}/messages tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of webhook messages. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_messages examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks/{id}/messages",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getwebhookmessages/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getwebhookmessages/index.md"
        }
      ]
    },
    {
      "id": "api/getsinglewebhookmessage/index.md",
      "kind": "operation",
      "title": "Get a single message from a webhook.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessage/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessage/index.md",
      "file": "api/getsinglewebhookmessage/index.md",
      "searchText": "operationId getSingleWebhookMessage summary Get a single message from a webhook. description 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. method get path /v1/webhooks/{id}/messages/{messageId} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name messageId in path description The webhook message ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A single webhook message. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_messages examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks/{id}/messages/{messageId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessage/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessage/index.md"
        }
      ]
    },
    {
      "id": "api/deletewebhookmessage/index.md",
      "kind": "operation",
      "title": "Delete a webhook message.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletewebhookmessage/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhookmessage/index.md",
      "file": "api/deletewebhookmessage/index.md",
      "searchText": "operationId deleteWebhookMessage summary Delete a webhook message. description 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. method delete path /v1/webhooks/{id}/messages/{messageId} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name messageId in path description The webhook message ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Webhook message deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/webhooks/{id}/messages/{messageId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletewebhookmessage/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhookmessage/index.md"
        }
      ]
    },
    {
      "id": "api/getwebhookmessageattempts/index.md",
      "kind": "operation",
      "title": "Get all the failed attempts of a single webhook message.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getwebhookmessageattempts/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getwebhookmessageattempts/index.md",
      "file": "api/getwebhookmessageattempts/index.md",
      "searchText": "operationId getWebhookMessageAttempts summary Get all the failed attempts of a single webhook message. description 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. method get path /v1/webhooks/{id}/messages/{messageId}/attempts tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  4 name messageId in path description The webhook message ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of webhook attempts. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_attempts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks/{id}/messages/{messageId}/attempts",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getwebhookmessageattempts/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getwebhookmessageattempts/index.md"
        }
      ]
    },
    {
      "id": "api/getsinglewebhookmessageattempt/index.md",
      "kind": "operation",
      "title": "Get a single failed attempt from a single webhook message.",
      "description": "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 attempt must match the corresponding webhook and webhook message.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessageattempt/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessageattempt/index.md",
      "file": "api/getsinglewebhookmessageattempt/index.md",
      "searchText": "operationId getSingleWebhookMessageAttempt summary Get a single failed attempt from a single webhook message. description 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 attempt must match the corresponding webhook and webhook message. method get path /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name messageId in path description The webhook message ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name attemptId in path description The webhook attempt ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A single webhook attempt. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_attempts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  required 0 type 1 id 2 attributes required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessageattempt/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getsinglewebhookmessageattempt/index.md"
        }
      ]
    },
    {
      "id": "api/deletewebhookmessageattempt/index.md",
      "kind": "operation",
      "title": "Delete a webhook attempt.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletewebhookmessageattempt/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhookmessageattempt/index.md",
      "file": "api/deletewebhookmessageattempt/index.md",
      "searchText": "operationId deleteWebhookMessageAttempt summary Delete a webhook attempt. description 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. method delete path /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name messageId in path description The webhook message ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  3 name attemptId in path description The webhook message attempt ID. required  deprecated  style  explode  allowReserved  schema name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Webhook message attempt deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletewebhookmessageattempt/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhookmessageattempt/index.md"
        }
      ]
    },
    {
      "id": "api/submitwebhook/index.md",
      "kind": "operation",
      "title": "Submit messages for a webhook.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/submitwebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/submitwebhook/index.md",
      "file": "api/submitwebhook/index.md",
      "searchText": "operationId submitWebhook summary Submit messages for a webhook. description 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. method post path /v1/webhooks/{id}/submit tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description OK. content  headers  links  1 statusCode 204 summary  description No messages to send, so did nothing. content  headers  links  2 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/webhooks/{id}/submit",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/submitwebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/submitwebhook/index.md"
        }
      ]
    },
    {
      "id": "api/triggertransactionwebhook/index.md",
      "kind": "operation",
      "title": "Trigger webhook for a given transaction.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/triggertransactionwebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/triggertransactionwebhook/index.md",
      "file": "api/triggertransactionwebhook/index.md",
      "searchText": "operationId triggerTransactionWebhook summary Trigger webhook for a given transaction. description 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. method post path /v1/webhooks/{id}/trigger-transaction/{transactionId} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  2 name transactionId in path description The transaction ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example  examples  requestBody  responses 0 statusCode 204 summary  description Webhook triggered successfully. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/webhooks/{id}/trigger-transaction/{transactionId}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/triggertransactionwebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/triggertransactionwebhook/index.md"
        }
      ]
    },
    {
      "id": "api/listwebhook/index.md",
      "kind": "operation",
      "title": "List all webhooks.",
      "description": "List all the user's webhooks.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/listwebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/listwebhook/index.md",
      "file": "api/listwebhook/index.md",
      "searchText": "operationId listWebhook summary List all webhooks. description List all the user's webhooks. method get path /v1/webhooks tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name limit in query description Number of items per page. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10 examples  refName  content  example  examples  2 name page in query description Page number. The default pagination is per 50 items. required  deprecated  style  explode  allowReserved  schema name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  content  example  examples  requestBody  responses 0 statusCode 200 summary  description A list of webhooks. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/listwebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/listwebhook/index.md"
        }
      ]
    },
    {
      "id": "api/storewebhook/index.md",
      "kind": "operation",
      "title": "Store a new webhook",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/storewebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/storewebhook/index.md",
      "file": "api/storewebhook/index.md",
      "searchText": "operationId storeWebhook summary Store a new webhook description 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.\n method post path /v1/webhooks tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  requestBody description JSON array or key=value pairs with the necessary webhook information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single webhook (store) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookStore properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single webhook (store) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookStore properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description New webhook stored, result in response. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "POST /v1/webhooks",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/storewebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/storewebhook/index.md"
        }
      ]
    },
    {
      "id": "api/getwebhook/index.md",
      "kind": "operation",
      "title": "Get a single webhook.",
      "description": "Gets all info of a single webhook.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/getwebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/getwebhook/index.md",
      "file": "api/getwebhook/index.md",
      "searchText": "operationId getWebhook summary Get a single webhook. description Gets all info of a single webhook. method get path /v1/webhooks/{id} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example 123 examples  requestBody  responses 0 statusCode 200 summary  description The requested webhook. content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "GET /v1/webhooks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/getwebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/getwebhook/index.md"
        }
      ]
    },
    {
      "id": "api/updatewebhook/index.md",
      "kind": "operation",
      "title": "Update existing webhook.",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/updatewebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/updatewebhook/index.md",
      "file": "api/updatewebhook/index.md",
      "searchText": "operationId updateWebhook summary Update existing webhook. description 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. method put path /v1/webhooks/{id} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example 123 examples  requestBody description JSON array with updated webhook information. See the model for the exact specifications. required  content application/json schema name  type object format  title A single webhook (update) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookUpdate properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  application/x-www-form-urlencoded schema name  type object format  title A single webhook (update) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookUpdate properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  responses 0 statusCode 200 summary  description Updated webhook stored, result in response content application/vnd.api+json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data example  examples  encoding  prefixEncoding  itemEncoding  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 422 summary  description Validation error. The body will have the exact details. content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  5 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "PUT /v1/webhooks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/updatewebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/updatewebhook/index.md"
        }
      ]
    },
    {
      "id": "api/deletewebhook/index.md",
      "kind": "operation",
      "title": "Delete a webhook.",
      "description": "DELETE /v1/webhooks/{id}.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/deletewebhook/",
      "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhook/index.md",
      "file": "api/deletewebhook/index.md",
      "searchText": "operationId deleteWebhook summary Delete a webhook. description Delete a webhook. method delete path /v1/webhooks/{id} tags 0 webhooks parameters 0 name X-Trace-Id in header description Unique identifier associated with this request. required  deprecated  style  explode  allowReserved  schema name  type string format uuid title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  refName  content  example 40c71bbb-c676-4f24-83cf-cc725d7d7a00 examples  1 name id in path description The webhook ID. required  deprecated  style  explode  allowReserved  schema name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  content  example 123 examples  requestBody  responses 0 statusCode 204 summary  description Webhook deleted. content  headers  links  1 statusCode 400 summary  description Bad request content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  2 statusCode 401 summary  description Unauthenticated content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  3 statusCode 404 summary  description Page not found content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  4 statusCode 500 summary  description Internal exception content application/json schema name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName  example  examples  encoding  prefixEncoding  itemEncoding  headers  links  security 0 firefly_iii_auth  1 local_bearer_auth  deprecated  servers  externalDocs  callbacks  hidden  codeSamples ",
      "documentId": "DELETE /v1/webhooks/{id}",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/deletewebhook/",
          "markdown": "https://sourcey-firefly.pages.dev/api/deletewebhook/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountarray/index.md",
      "kind": "schema",
      "title": "AccountArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountarray/index.md",
      "file": "api/models/accountarray/index.md",
      "searchText": "name AccountArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:AccountArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentarray/index.md",
      "kind": "schema",
      "title": "AttachmentArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentarray/index.md",
      "file": "api/models/attachmentarray/index.md",
      "searchText": "name AttachmentArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:AttachmentArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleteaccountarray/index.md",
      "kind": "schema",
      "title": "AutocompleteAccountArray",
      "description": "A list of AutocompleteAccount.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccountarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccountarray/index.md",
      "file": "api/models/autocompleteaccountarray/index.md",
      "searchText": "name AutocompleteAccountArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteAccountArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteAccount properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the account found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account examples  refName  name_with_balance name  type string format string title  description Asset accounts and liabilities have a second field with the given date's account balance in the account currency or primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account ($123.45) examples  refName  active name  type boolean format  title  description Is the account active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type string format string title  description Account type of the account found by the auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName  currency_id name  type string format string title  description ID for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_name name  type string format string title  description Currency name for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_id name  type string format string title  description ID for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency ID is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_name name  type string format string title  description Name for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency name is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example US Dollar examples  refName  account_currency_code name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  account_currency_symbol name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  account_currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 name_with_balance 3 active 4 type 5 currency_id 6 currency_name 7 currency_code 8 currency_symbol 9 currency_decimal_places 10 account_currency_id 11 account_currency_name 12 account_currency_code 13 account_currency_symbol 14 account_currency_decimal_places",
      "documentId": "schema:AutocompleteAccountArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccountarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccountarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletebillarray/index.md",
      "kind": "schema",
      "title": "AutocompleteBillArray",
      "description": "A list of AutocompleteBill.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebillarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebillarray/index.md",
      "file": "api/models/autocompletebillarray/index.md",
      "searchText": "name AutocompleteBillArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBillArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBill properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the bill found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active",
      "documentId": "schema:AutocompleteBillArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebillarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebillarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletebudgetarray/index.md",
      "kind": "schema",
      "title": "AutocompleteBudgetArray",
      "description": "A list of AutocompleteBudget.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebudgetarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebudgetarray/index.md",
      "file": "api/models/autocompletebudgetarray/index.md",
      "searchText": "name AutocompleteBudgetArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBudgetArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBudget properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the budget found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  active name  type boolean format  title  description Is the budget active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active",
      "documentId": "schema:AutocompleteBudgetArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebudgetarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebudgetarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecategoryarray/index.md",
      "kind": "schema",
      "title": "AutocompleteCategoryArray",
      "description": "A list of AutocompleteCategory.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecategoryarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecategoryarray/index.md",
      "file": "api/models/autocompletecategoryarray/index.md",
      "searchText": "name AutocompleteCategoryArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCategoryArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCategory properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the category found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Category X examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteCategoryArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecategoryarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecategoryarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecurrencyarray/index.md",
      "kind": "schema",
      "title": "AutocompleteCurrencyArray",
      "description": "A list of AutocompleteCurrency.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencyarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencyarray/index.md",
      "file": "api/models/autocompletecurrencyarray/index.md",
      "searchText": "name AutocompleteCurrencyArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrencyArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrency properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Currency name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Currency name examples  refName  code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 code 3 symbol 4 decimal_places",
      "documentId": "schema:AutocompleteCurrencyArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencyarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencyarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecurrencycodearray/index.md",
      "kind": "schema",
      "title": "AutocompleteCurrencyCodeArray",
      "description": "A list of AutocompleteCurrencyCode.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycodearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycodearray/index.md",
      "file": "api/models/autocompletecurrencycodearray/index.md",
      "searchText": "name AutocompleteCurrencyCodeArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrencyCode properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Currency name with the code between brackets. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Currency name (XCN) examples  refName  code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 code 3 symbol 4 decimal_places",
      "documentId": "schema:AutocompleteCurrencyCodeArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycodearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycodearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleteobjectgrouparray/index.md",
      "kind": "schema",
      "title": "AutocompleteObjectGroupArray",
      "description": "A list of AutocompleteObjectGroup.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgrouparray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgrouparray/index.md",
      "file": "api/models/autocompleteobjectgrouparray/index.md",
      "searchText": "name AutocompleteObjectGroupArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteObjectGroupArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteObjectGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  title name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  required 0 id 1 title 2 name",
      "documentId": "schema:AutocompleteObjectGroupArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgrouparray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgrouparray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletepiggyarray/index.md",
      "kind": "schema",
      "title": "AutocompletePiggyArray",
      "description": "A list of AutocompletePiggy.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggyarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggyarray/index.md",
      "file": "api/models/autocompletepiggyarray/index.md",
      "searchText": "name AutocompletePiggyArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggy properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the piggy bank found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch examples  refName  currency_id name  type string format string title  description Currency ID for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompletePiggyArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggyarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggyarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletepiggybalancearray/index.md",
      "kind": "schema",
      "title": "AutocompletePiggyBalanceArray",
      "description": "A list of AutocompletePiggyBalance.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalancearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalancearray/index.md",
      "file": "api/models/autocompletepiggybalancearray/index.md",
      "searchText": "name AutocompletePiggyBalanceArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggyBalanceArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggyBalance properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the piggy bank found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch examples  refName  name_with_balance name  type string format string title  description Name of the piggy bank found by an auto-complete search, including the currently saved amount and the target amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch ($234.56 / $600) examples  refName  currency_id name  type string format string title  description Currency ID for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Currency decimal places for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompletePiggyBalanceArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalancearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalancearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterecurrencearray/index.md",
      "kind": "schema",
      "title": "AutocompleteRecurrenceArray",
      "description": "A list of AutocompleteRecurrence.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrencearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrencearray/index.md",
      "file": "api/models/autocompleterecurrencearray/index.md",
      "searchText": "name AutocompleteRecurrenceArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRecurrenceArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRecurrence properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the recurrence found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  description name  type string format string title  description Description of the recurrence found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Should trigger daily. examples  refName  active name  type boolean format  title  description Is the recurring transaction active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRecurrenceArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrencearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrencearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterulearray/index.md",
      "kind": "schema",
      "title": "AutocompleteRuleArray",
      "description": "A list of AutocompleteRule.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulearray/index.md",
      "file": "api/models/autocompleterulearray/index.md",
      "searchText": "name AutocompleteRuleArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRule properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule one examples  refName  description name  type string format string title  description Description of the rule found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Useful rule. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRuleArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterulegrouparray/index.md",
      "kind": "schema",
      "title": "AutocompleteRuleGroupArray",
      "description": "A list of AutocompleteRuleGroup.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegrouparray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegrouparray/index.md",
      "file": "api/models/autocompleterulegrouparray/index.md",
      "searchText": "name AutocompleteRuleGroupArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleGroupArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule group one examples  refName  description name  type string format string title  description Description of the rule group found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some rule group. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRuleGroupArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegrouparray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegrouparray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetagarray/index.md",
      "kind": "schema",
      "title": "AutocompleteTagArray",
      "description": "A list of AutocompleteTag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetagarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetagarray/index.md",
      "file": "api/models/autocompletetagarray/index.md",
      "searchText": "name AutocompleteTagArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTagArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTag properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  tag name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  required 0 id 1 name 2 tag",
      "documentId": "schema:AutocompleteTagArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetagarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetagarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactionarray/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionArray",
      "description": "A list of AutocompleteTransaction.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionarray/index.md",
      "file": "api/models/autocompletetransactionarray/index.md",
      "searchText": "name AutocompleteTransactionArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransaction properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  description name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransactionArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactionidarray/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionIDArray",
      "description": "A list of AutocompleteTransactionID.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionidarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionidarray/index.md",
      "file": "api/models/autocompletetransactionidarray/index.md",
      "searchText": "name AutocompleteTransactionIDArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionID properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  description name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransactionIDArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionidarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionidarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactiontypearray/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionTypeArray",
      "description": "A list of AutocompleteTransactionType.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontypearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontypearray/index.md",
      "file": "api/models/autocompletetransactiontypearray/index.md",
      "searchText": "name AutocompleteTransactionTypeArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionTypeArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionType properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Type of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  type name  type string format string title  description Name of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  required 0 id 1 name 2 type",
      "documentId": "schema:AutocompleteTransactionTypeArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontypearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontypearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactionwithmetaarray/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionWithMetaArray",
      "description": "A list of AutocompleteTransactionWithMeta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmetaarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmetaarray/index.md",
      "file": "api/models/autocompletetransactionwithmetaarray/index.md",
      "searchText": "name AutocompleteTransactionWithMetaArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionWithMetaArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionWithMeta properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  description name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  currency_code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransactionWithMetaArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmetaarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmetaarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/availablebudgetarray/index.md",
      "kind": "schema",
      "title": "AvailableBudgetArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetarray/index.md",
      "file": "api/models/availablebudgetarray/index.md",
      "searchText": "name AvailableBudgetArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:AvailableBudgetArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/billarray/index.md",
      "kind": "schema",
      "title": "BillArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billarray/index.md",
      "file": "api/models/billarray/index.md",
      "searchText": "name BillArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:BillArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetarray/index.md",
      "kind": "schema",
      "title": "BudgetArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetarray/index.md",
      "file": "api/models/budgetarray/index.md",
      "searchText": "name BudgetArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:BudgetArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitarray/index.md",
      "kind": "schema",
      "title": "BudgetLimitArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitarray/index.md",
      "file": "api/models/budgetlimitarray/index.md",
      "searchText": "name BudgetLimitArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:BudgetLimitArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/categoryarray/index.md",
      "kind": "schema",
      "title": "CategoryArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categoryarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryarray/index.md",
      "file": "api/models/categoryarray/index.md",
      "searchText": "name CategoryArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:CategoryArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categoryarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/configurationarray/index.md",
      "kind": "schema",
      "title": "ConfigurationArray",
      "description": "A list of Configuration.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configurationarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationarray/index.md",
      "file": "api/models/configurationarray/index.md",
      "searchText": "name ConfigurationArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationArray items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable",
      "documentId": "schema:ConfigurationArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configurationarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyarray/index.md",
      "kind": "schema",
      "title": "CurrencyArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyarray/index.md",
      "file": "api/models/currencyarray/index.md",
      "searchText": "name CurrencyArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:CurrencyArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeratearray/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratearray/index.md",
      "file": "api/models/currencyexchangeratearray/index.md",
      "searchText": "name CurrencyExchangeRateArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:CurrencyExchangeRateArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/linktypearray/index.md",
      "kind": "schema",
      "title": "LinkTypeArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/linktypearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypearray/index.md",
      "file": "api/models/linktypearray/index.md",
      "searchText": "name LinkTypeArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:LinkTypeArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/linktypearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectgrouparray/index.md",
      "kind": "schema",
      "title": "ObjectGroupArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectgrouparray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgrouparray/index.md",
      "file": "api/models/objectgrouparray/index.md",
      "searchText": "name ObjectGroupArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:ObjectGroupArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectgrouparray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgrouparray/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankarray/index.md",
      "kind": "schema",
      "title": "PiggyBankArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankarray/index.md",
      "file": "api/models/piggybankarray/index.md",
      "searchText": "name PiggyBankArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:PiggyBankArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankeventarray/index.md",
      "kind": "schema",
      "title": "PiggyBankEventArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventarray/index.md",
      "file": "api/models/piggybankeventarray/index.md",
      "searchText": "name PiggyBankEventArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_bank_events examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_journal_id name  type string format string title  description The journal associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  transaction_group_id name  type string format string title  description The transaction group associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:PiggyBankEventArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/preferencearray/index.md",
      "kind": "schema",
      "title": "PreferenceArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/preferencearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/preferencearray/index.md",
      "file": "api/models/preferencearray/index.md",
      "searchText": "name PreferenceArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:PreferenceArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/preferencearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/preferencearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencearray/index.md",
      "kind": "schema",
      "title": "RecurrenceArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencearray/index.md",
      "file": "api/models/recurrencearray/index.md",
      "searchText": "name RecurrenceArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:RecurrenceArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulearray/index.md",
      "kind": "schema",
      "title": "RuleArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulearray/index.md",
      "file": "api/models/rulearray/index.md",
      "searchText": "name RuleArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:RuleArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegrouparray/index.md",
      "kind": "schema",
      "title": "RuleGroupArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegrouparray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegrouparray/index.md",
      "file": "api/models/rulegrouparray/index.md",
      "searchText": "name RuleGroupArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:RuleGroupArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegrouparray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegrouparray/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagarray/index.md",
      "kind": "schema",
      "title": "TagArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagarray/index.md",
      "file": "api/models/tagarray/index.md",
      "searchText": "name TagArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:TagArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionarray/index.md",
      "kind": "schema",
      "title": "TransactionArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionarray/index.md",
      "file": "api/models/transactionarray/index.md",
      "searchText": "name TransactionArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:TransactionArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlinkarray/index.md",
      "kind": "schema",
      "title": "TransactionLinkArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkarray/index.md",
      "file": "api/models/transactionlinkarray/index.md",
      "searchText": "name TransactionLinkArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:TransactionLinkArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/userarray/index.md",
      "kind": "schema",
      "title": "UserArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/userarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/userarray/index.md",
      "file": "api/models/userarray/index.md",
      "searchText": "name UserArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:UserArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/userarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/userarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergrouparray/index.md",
      "kind": "schema",
      "title": "UserGroupArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergrouparray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergrouparray/index.md",
      "file": "api/models/usergrouparray/index.md",
      "searchText": "name UserGroupArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:UserGroupArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergrouparray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergrouparray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookarray/index.md",
      "kind": "schema",
      "title": "WebhookArray",
      "description": "Fields: data, meta and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookarray/index.md",
      "file": "api/models/webhookarray/index.md",
      "searchText": "name WebhookArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName  required 0 data 1 meta 2 links",
      "documentId": "schema:WebhookArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookattemptarray/index.md",
      "kind": "schema",
      "title": "WebhookAttemptArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptarray/index.md",
      "file": "api/models/webhookattemptarray/index.md",
      "searchText": "name WebhookAttemptArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_attempts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:WebhookAttemptArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookmessagearray/index.md",
      "kind": "schema",
      "title": "WebhookMessageArray",
      "description": "Fields: data and meta.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessagearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessagearray/index.md",
      "file": "api/models/webhookmessagearray/index.md",
      "searchText": "name WebhookMessageArray type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageArray properties data name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_messages examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName  required 0 type 1 id 2 attributes meta name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 data 1 meta",
      "documentId": "schema:WebhookMessageArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessagearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessagearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleteaccount/index.md",
      "kind": "schema",
      "title": "AutocompleteAccount",
      "description": "Fields: id, name, name_with_balance, active, type, currency_id and 9 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccount/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccount/index.md",
      "file": "api/models/autocompleteaccount/index.md",
      "searchText": "name AutocompleteAccount type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteAccount properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the account found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account examples  refName  name_with_balance name  type string format string title  description Asset accounts and liabilities have a second field with the given date's account balance in the account currency or primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking Account ($123.45) examples  refName  active name  type boolean format  title  description Is the account active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type string format string title  description Account type of the account found by the auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName  currency_id name  type string format string title  description ID for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_name name  type string format string title  description Currency name for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_id name  type string format string title  description ID for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency ID is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  account_currency_name name  type string format string title  description Name for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency name is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example US Dollar examples  refName  account_currency_code name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  account_currency_symbol name  type string format string title  description Code for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  account_currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this account. Even if \"convertToPrimary\" is on, the account currency code is displayed here. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 name_with_balance 3 active 4 type 5 currency_id 6 currency_name 7 currency_code 8 currency_symbol 9 currency_decimal_places 10 account_currency_id 11 account_currency_name 12 account_currency_code 13 account_currency_symbol 14 account_currency_decimal_places",
      "documentId": "schema:AutocompleteAccount",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccount/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteaccount/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletebill/index.md",
      "kind": "schema",
      "title": "AutocompleteBill",
      "description": "Fields: id, name and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebill/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebill/index.md",
      "file": "api/models/autocompletebill/index.md",
      "searchText": "name AutocompleteBill type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBill properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the bill found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active",
      "documentId": "schema:AutocompleteBill",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebill/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebill/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletebudget/index.md",
      "kind": "schema",
      "title": "AutocompleteBudget",
      "description": "Fields: id, name and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebudget/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebudget/index.md",
      "file": "api/models/autocompletebudget/index.md",
      "searchText": "name AutocompleteBudget type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteBudget properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the budget found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  active name  type boolean format  title  description Is the budget active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name 2 active",
      "documentId": "schema:AutocompleteBudget",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletebudget/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletebudget/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecategory/index.md",
      "kind": "schema",
      "title": "AutocompleteCategory",
      "description": "Fields: id and name.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecategory/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecategory/index.md",
      "file": "api/models/autocompletecategory/index.md",
      "searchText": "name AutocompleteCategory type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCategory properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the category found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Category X examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteCategory",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecategory/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecategory/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecurrency/index.md",
      "kind": "schema",
      "title": "AutocompleteCurrency",
      "description": "Fields: id, name, code, symbol and decimal_places.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrency/index.md",
      "file": "api/models/autocompletecurrency/index.md",
      "searchText": "name AutocompleteCurrency type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrency properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Currency name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Currency name examples  refName  code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 code 3 symbol 4 decimal_places",
      "documentId": "schema:AutocompleteCurrency",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrency/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletecurrencycode/index.md",
      "kind": "schema",
      "title": "AutocompleteCurrencyCode",
      "description": "Fields: id, name, code, symbol and decimal_places.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycode/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycode/index.md",
      "file": "api/models/autocompletecurrencycode/index.md",
      "searchText": "name AutocompleteCurrencyCode type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteCurrencyCode properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Currency name with the code between brackets. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Currency name (XCN) examples  refName  code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 id 1 name 2 code 3 symbol 4 decimal_places",
      "documentId": "schema:AutocompleteCurrencyCode",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycode/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletecurrencycode/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleteobjectgroup/index.md",
      "kind": "schema",
      "title": "AutocompleteObjectGroup",
      "description": "Fields: id, name and title.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgroup/index.md",
      "file": "api/models/autocompleteobjectgroup/index.md",
      "searchText": "name AutocompleteObjectGroup type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteObjectGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  title name  type string format string title  description Title of the object group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Object Group one examples  refName  required 0 id 1 title 2 name",
      "documentId": "schema:AutocompleteObjectGroup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleteobjectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletepiggy/index.md",
      "kind": "schema",
      "title": "AutocompletePiggy",
      "description": "Fields: id, name, currency_id, currency_code, currency_symbol, currency_name and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggy/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggy/index.md",
      "file": "api/models/autocompletepiggy/index.md",
      "searchText": "name AutocompletePiggy type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggy properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the piggy bank found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch examples  refName  currency_id name  type string format string title  description Currency ID for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimal places for the currency used by this piggy bank. This will always be the currency of the piggy bank, never the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompletePiggy",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggy/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggy/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletepiggybalance/index.md",
      "kind": "schema",
      "title": "AutocompletePiggyBalance",
      "description": "Fields: id, name, name_with_balance, currency_id, currency_code, currency_symbol and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalance/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalance/index.md",
      "file": "api/models/autocompletepiggybalance/index.md",
      "searchText": "name AutocompletePiggyBalance type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompletePiggyBalance properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the piggy bank found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch examples  refName  name_with_balance name  type string format string title  description Name of the piggy bank found by an auto-complete search, including the currently saved amount and the target amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New couch ($234.56 / $600) examples  refName  currency_id name  type string format string title  description Currency ID for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Currency decimal places for the currency used by this piggy bank. This will always be the piggy bank's currency, never the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompletePiggyBalance",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalance/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletepiggybalance/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterecurrence/index.md",
      "kind": "schema",
      "title": "AutocompleteRecurrence",
      "description": "Fields: id, name, description and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrence/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrence/index.md",
      "file": "api/models/autocompleterecurrence/index.md",
      "searchText": "name AutocompleteRecurrence type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRecurrence properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the recurrence found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Yearly bill examples  refName  description name  type string format string title  description Description of the recurrence found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Should trigger daily. examples  refName  active name  type boolean format  title  description Is the recurring transaction active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRecurrence",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrence/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterecurrence/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterule/index.md",
      "kind": "schema",
      "title": "AutocompleteRule",
      "description": "Fields: id, name, description and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterule/index.md",
      "file": "api/models/autocompleterule/index.md",
      "searchText": "name AutocompleteRule type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRule properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule one examples  refName  description name  type string format string title  description Description of the rule found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Useful rule. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRule",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterule/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompleterulegroup/index.md",
      "kind": "schema",
      "title": "AutocompleteRuleGroup",
      "description": "Fields: id, name, description and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegroup/index.md",
      "file": "api/models/autocompleterulegroup/index.md",
      "searchText": "name AutocompleteRuleGroup type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteRuleGroup properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the rule group found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rule group one examples  refName  description name  type string format string title  description Description of the rule group found by auto-complete. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some rule group. examples  refName  active name  type boolean format  title  description Is the bill active or not? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 id 1 name",
      "documentId": "schema:AutocompleteRuleGroup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompleterulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetag/index.md",
      "kind": "schema",
      "title": "AutocompleteTag",
      "description": "Fields: id, name and tag.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetag/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetag/index.md",
      "file": "api/models/autocompletetag/index.md",
      "searchText": "name AutocompleteTag type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTag properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  tag name  type string format string title  description Name of the tag found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example too-expensive-tag-example examples  refName  required 0 id 1 name 2 tag",
      "documentId": "schema:AutocompleteTag",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetag/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetag/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransaction/index.md",
      "kind": "schema",
      "title": "AutocompleteTransaction",
      "description": "Fields: id, transaction_group_id, name and description.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransaction/index.md",
      "file": "api/models/autocompletetransaction/index.md",
      "searchText": "name AutocompleteTransaction type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransaction properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  description name  type string format string title  description Transaction description default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Transaction examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransaction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransaction/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactionid/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionID",
      "description": "Fields: id, transaction_group_id, name and description.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionid/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionid/index.md",
      "file": "api/models/autocompletetransactionid/index.md",
      "searchText": "name AutocompleteTransactionID type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionID properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  description name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransactionID",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionid/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionid/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactiontype/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionType",
      "description": "Fields: id, name and type.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontype/index.md",
      "file": "api/models/autocompletetransactiontype/index.md",
      "searchText": "name AutocompleteTransactionType type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionType properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Type of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  type name  type string format string title  description Name of the object found by an auto-complete search. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Withdrawal examples  refName  required 0 id 1 name 2 type",
      "documentId": "schema:AutocompleteTransactionType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactiontype/index.md"
        }
      ]
    },
    {
      "id": "api/models/autocompletetransactionwithmeta/index.md",
      "kind": "schema",
      "title": "AutocompleteTransactionWithMeta",
      "description": "Fields: id, transaction_group_id, name, description, date, currency_code and 1 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmeta/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmeta/index.md",
      "file": "api/models/autocompletetransactionwithmeta/index.md",
      "searchText": "name AutocompleteTransactionWithMeta type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AutocompleteTransactionWithMeta properties id name  type string format string title  description The ID of a transaction journal (basically a single split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_group_id name  type string format string title  description The ID of the underlying transaction group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  name name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  description name  type string format string title  description Transaction description with ID in the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example #12: Transaction examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  currency_code name  type string format string title  description Currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id 1 name 2 description",
      "documentId": "schema:AutocompleteTransactionWithMeta",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmeta/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autocompletetransactionwithmeta/index.md"
        }
      ]
    },
    {
      "id": "api/models/chartdatapoint/index.md",
      "kind": "schema",
      "title": "ChartDataPoint",
      "description": "Field: key.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/chartdatapoint/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdatapoint/index.md",
      "file": "api/models/chartdatapoint/index.md",
      "searchText": "name ChartDataPoint type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName ",
      "documentId": "schema:ChartDataPoint",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/chartdatapoint/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdatapoint/index.md"
        }
      ]
    },
    {
      "id": "api/models/chartdataset/index.md",
      "kind": "schema",
      "title": "ChartDataSet",
      "description": "Fields: label, currency_id, currency_name, currency_code, currency_symbol, currency_decimal_places and 13 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/chartdataset/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdataset/index.md",
      "file": "api/models/chartdataset/index.md",
      "searchText": "name ChartDataSet type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName ",
      "documentId": "schema:ChartDataSet",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/chartdataset/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdataset/index.md"
        }
      ]
    },
    {
      "id": "api/models/chartline/index.md",
      "kind": "schema",
      "title": "ChartLine",
      "description": "A list of ChartDataSet.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/chartline/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/chartline/index.md",
      "file": "api/models/chartline/index.md",
      "searchText": "name ChartLine type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartLine items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataSet properties label name  type string format string title  description This is the title of the current set. It can refer to an account, a budget or another object (by name). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  type name  type string format string title  description Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example line examples  refName  period name  type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty yAxisID name  type integer format int32 title  description Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName  pc_entries name  type object format  title  description The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ChartDataPoint properties key name  type string format string title  description The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example value examples  refName ",
      "documentId": "schema:ChartLine",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/chartline/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/chartline/index.md"
        }
      ]
    },
    {
      "id": "api/models/datadestroyobject/index.md",
      "kind": "schema",
      "title": "DataDestroyObject",
      "description": "One of: not_assets_liabilities, budgets, bills, piggy_banks, rules, recurring and 12 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/datadestroyobject/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/datadestroyobject/index.md",
      "file": "api/models/datadestroyobject/index.md",
      "searchText": "name DataDestroyObject type string format  title  description  default  enum 0 not_assets_liabilities 1 budgets 2 bills 3 piggy_banks 4 rules 5 recurring 6 categories 7 tags 8 object_groups 9 accounts 10 asset_accounts 11 expense_accounts 12 revenue_accounts 13 liabilities 14 transactions 15 withdrawals 16 deposits 17 transfers enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName DataDestroyObject",
      "documentId": "schema:DataDestroyObject",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/datadestroyobject/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/datadestroyobject/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountsearchfieldfilter/index.md",
      "kind": "schema",
      "title": "AccountSearchFieldFilter",
      "description": "One of: all, iban, name, number and id.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountsearchfieldfilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountsearchfieldfilter/index.md",
      "file": "api/models/accountsearchfieldfilter/index.md",
      "searchText": "name AccountSearchFieldFilter type string format  title  description  default  enum 0 all 1 iban 2 name 3 number 4 id enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSearchFieldFilter",
      "documentId": "schema:AccountSearchFieldFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountsearchfieldfilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountsearchfieldfilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/configvaluefilter/index.md",
      "kind": "schema",
      "title": "ConfigValueFilter",
      "description": "Title of the configuration value.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configvaluefilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configvaluefilter/index.md",
      "file": "api/models/configvaluefilter/index.md",
      "searchText": "name ConfigValueFilter type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter",
      "documentId": "schema:ConfigValueFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configvaluefilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configvaluefilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/configvalueupdatefilter/index.md",
      "kind": "schema",
      "title": "ConfigValueUpdateFilter",
      "description": "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.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/index.md",
      "file": "api/models/configvalueupdatefilter/index.md",
      "searchText": "name ConfigValueUpdateFilter type string format  title  description  default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 configuration.enable_exchange_rates 5 configuration.use_running_balance 6 configuration.enable_external_map 7 configuration.enable_external_rates 8 configuration.allow_webhooks 9 configuration.valid_url_protocols enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigValueUpdateFilter",
      "documentId": "schema:ConfigValueUpdateFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configvalueupdatefilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/exportfilefilter/index.md",
      "kind": "schema",
      "title": "ExportFileFilter",
      "description": "One of: csv.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/exportfilefilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/exportfilefilter/index.md",
      "file": "api/models/exportfilefilter/index.md",
      "searchText": "name ExportFileFilter type string format  title  description  default  enum 0 csv enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ExportFileFilter",
      "documentId": "schema:ExportFileFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/exportfilefilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/exportfilefilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/insightgroup/index.md",
      "kind": "schema",
      "title": "InsightGroup",
      "description": "A list of InsightGroupEntry.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insightgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insightgroup/index.md",
      "file": "api/models/insightgroup/index.md",
      "searchText": "name InsightGroup type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroup items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightGroup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insightgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insightgroup/index.md"
        }
      ]
    },
    {
      "id": "api/models/insightgroupentry/index.md",
      "kind": "schema",
      "title": "InsightGroupEntry",
      "description": "Fields: id, name, difference, difference_float, currency_id and currency_code.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insightgroupentry/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insightgroupentry/index.md",
      "file": "api/models/insightgroupentry/index.md",
      "searchText": "name InsightGroupEntry type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightGroupEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightGroupEntry",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insightgroupentry/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insightgroupentry/index.md"
        }
      ]
    },
    {
      "id": "api/models/insighttotal/index.md",
      "kind": "schema",
      "title": "InsightTotal",
      "description": "A list of InsightTotalEntry.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insighttotal/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttotal/index.md",
      "file": "api/models/insighttotal/index.md",
      "searchText": "name InsightTotal type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotal items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightTotal",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insighttotal/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttotal/index.md"
        }
      ]
    },
    {
      "id": "api/models/insighttotalentry/index.md",
      "kind": "schema",
      "title": "InsightTotalEntry",
      "description": "Fields: difference, difference_float, currency_id and currency_code.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insighttotalentry/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttotalentry/index.md",
      "file": "api/models/insighttotalentry/index.md",
      "searchText": "name InsightTotalEntry type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTotalEntry properties difference name  type string format string title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  difference_float name  type number format double title  description The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightTotalEntry",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insighttotalentry/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttotalentry/index.md"
        }
      ]
    },
    {
      "id": "api/models/insighttransfer/index.md",
      "kind": "schema",
      "title": "InsightTransfer",
      "description": "A list of InsightTransferEntry.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insighttransfer/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttransfer/index.md",
      "file": "api/models/insighttransfer/index.md",
      "searchText": "name InsightTransfer type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTransfer items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTransferEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The total amount transferred between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  in name  type string format string title  description The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  in_float name  type number format double title  description The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out name  type string format string title  description The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out_float name  type number format double title  description The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightTransfer",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insighttransfer/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttransfer/index.md"
        }
      ]
    },
    {
      "id": "api/models/insighttransferentry/index.md",
      "kind": "schema",
      "title": "InsightTransferEntry",
      "description": "Fields: id, name, difference, difference_float, in, in_float and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/insighttransferentry/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttransferentry/index.md",
      "file": "api/models/insighttransferentry/index.md",
      "searchText": "name InsightTransferEntry type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InsightTransferEntry properties id name  type string format string title  description This ID is a reference to the original object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  name name  type string format string title  description This is the name of the object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Land lord examples  refName  difference name  type string format string title  description The total amount transferred between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  difference_float name  type number format double title  description The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -123.45 examples  refName  in name  type string format string title  description The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  in_float name  type number format double title  description The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out name  type string format string title  description The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  out_float name  type number format double title  description The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. May have rounding errors. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description The currency code of the expenses listed for this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName ",
      "documentId": "schema:InsightTransferEntry",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/insighttransferentry/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/insighttransferentry/index.md"
        }
      ]
    },
    {
      "id": "api/models/categoryread/index.md",
      "kind": "schema",
      "title": "CategoryRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categoryread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryread/index.md",
      "file": "api/models/categoryread/index.md",
      "searchText": "name CategoryRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes",
      "documentId": "schema:CategoryRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categoryread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryread/index.md"
        }
      ]
    },
    {
      "id": "api/models/categorysingle/index.md",
      "kind": "schema",
      "title": "CategorySingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categorysingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categorysingle/index.md",
      "file": "api/models/categorysingle/index.md",
      "searchText": "name CategorySingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategorySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example categories examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:CategorySingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categorysingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categorysingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/configurationsingle/index.md",
      "kind": "schema",
      "title": "ConfigurationSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configurationsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationsingle/index.md",
      "file": "api/models/configurationsingle/index.md",
      "searchText": "name ConfigurationSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable required 0 data",
      "documentId": "schema:ConfigurationSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configurationsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyread/index.md",
      "kind": "schema",
      "title": "CurrencyRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyread/index.md",
      "file": "api/models/currencyread/index.md",
      "searchText": "name CurrencyRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes",
      "documentId": "schema:CurrencyRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyread/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencysingle/index.md",
      "kind": "schema",
      "title": "CurrencySingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencysingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencysingle/index.md",
      "file": "api/models/currencysingle/index.md",
      "searchText": "name CurrencySingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencySingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencies examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:CurrencySingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencysingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencysingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/linktyperead/index.md",
      "kind": "schema",
      "title": "LinkTypeRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/linktyperead/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/linktyperead/index.md",
      "file": "api/models/linktyperead/index.md",
      "searchText": "name LinkTypeRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:LinkTypeRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/linktyperead/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/linktyperead/index.md"
        }
      ]
    },
    {
      "id": "api/models/linktypesingle/index.md",
      "kind": "schema",
      "title": "LinkTypeSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/linktypesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypesingle/index.md",
      "file": "api/models/linktypesingle/index.md",
      "searchText": "name LinkTypeSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example link_types examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:LinkTypeSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/linktypesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectgroupread/index.md",
      "kind": "schema",
      "title": "ObjectGroupRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupread/index.md",
      "file": "api/models/objectgroupread/index.md",
      "searchText": "name ObjectGroupRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes",
      "documentId": "schema:ObjectGroupRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupread/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectgroupsingle/index.md",
      "kind": "schema",
      "title": "ObjectGroupSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupsingle/index.md",
      "file": "api/models/objectgroupsingle/index.md",
      "searchText": "name ObjectGroupSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example object_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:ObjectGroupSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankeventread/index.md",
      "kind": "schema",
      "title": "PiggyBankEventRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventread/index.md",
      "file": "api/models/piggybankeventread/index.md",
      "searchText": "name PiggyBankEventRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_bank_events examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_journal_id name  type string format string title  description The journal associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  transaction_group_id name  type string format string title  description The transaction group associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:PiggyBankEventRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventread/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankread/index.md",
      "kind": "schema",
      "title": "PiggyBankRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankread/index.md",
      "file": "api/models/piggybankread/index.md",
      "searchText": "name PiggyBankRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:PiggyBankRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankread/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybanksingle/index.md",
      "kind": "schema",
      "title": "PiggyBankSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybanksingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybanksingle/index.md",
      "file": "api/models/piggybanksingle/index.md",
      "searchText": "name PiggyBankSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example piggy_banks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:PiggyBankSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybanksingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybanksingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/preferenceread/index.md",
      "kind": "schema",
      "title": "PreferenceRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/preferenceread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/preferenceread/index.md",
      "file": "api/models/preferenceread/index.md",
      "searchText": "name PreferenceRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes",
      "documentId": "schema:PreferenceRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/preferenceread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/preferenceread/index.md"
        }
      ]
    },
    {
      "id": "api/models/preferencesingle/index.md",
      "kind": "schema",
      "title": "PreferenceSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/preferencesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/preferencesingle/index.md",
      "file": "api/models/preferencesingle/index.md",
      "searchText": "name PreferenceSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example preferences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:PreferenceSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/preferencesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/preferencesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrenceread/index.md",
      "kind": "schema",
      "title": "RecurrenceRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceread/index.md",
      "file": "api/models/recurrenceread/index.md",
      "searchText": "name RecurrenceRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:RecurrenceRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceread/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencesingle/index.md",
      "kind": "schema",
      "title": "RecurrenceSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencesingle/index.md",
      "file": "api/models/recurrencesingle/index.md",
      "searchText": "name RecurrenceSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example recurrences examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:RecurrenceSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegroupread/index.md",
      "kind": "schema",
      "title": "RuleGroupRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupread/index.md",
      "file": "api/models/rulegroupread/index.md",
      "searchText": "name RuleGroupRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:RuleGroupRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupread/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegroupsingle/index.md",
      "kind": "schema",
      "title": "RuleGroupSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupsingle/index.md",
      "file": "api/models/rulegroupsingle/index.md",
      "searchText": "name RuleGroupSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules_group examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:RuleGroupSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleread/index.md",
      "kind": "schema",
      "title": "RuleRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleread/index.md",
      "file": "api/models/ruleread/index.md",
      "searchText": "name RuleRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:RuleRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleread/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulesingle/index.md",
      "kind": "schema",
      "title": "RuleSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulesingle/index.md",
      "file": "api/models/rulesingle/index.md",
      "searchText": "name RuleSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example rules examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:RuleSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagread/index.md",
      "kind": "schema",
      "title": "TagRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagread/index.md",
      "file": "api/models/tagread/index.md",
      "searchText": "name TagRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:TagRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagread/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagsingle/index.md",
      "kind": "schema",
      "title": "TagSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagsingle/index.md",
      "file": "api/models/tagsingle/index.md",
      "searchText": "name TagSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tags examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:TagSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlinkread/index.md",
      "kind": "schema",
      "title": "TransactionLinkRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkread/index.md",
      "file": "api/models/transactionlinkread/index.md",
      "searchText": "name TransactionLinkRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:TransactionLinkRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkread/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlinksingle/index.md",
      "kind": "schema",
      "title": "TransactionLinkSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinksingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinksingle/index.md",
      "file": "api/models/transactionlinksingle/index.md",
      "searchText": "name TransactionLinkSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactionLinks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:TransactionLinkSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinksingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinksingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionread/index.md",
      "kind": "schema",
      "title": "TransactionRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionread/index.md",
      "file": "api/models/transactionread/index.md",
      "searchText": "name TransactionRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:TransactionRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionread/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionsingle/index.md",
      "kind": "schema",
      "title": "TransactionSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsingle/index.md",
      "file": "api/models/transactionsingle/index.md",
      "searchText": "name TransactionSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example transactions examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:TransactionSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/userread/index.md",
      "kind": "schema",
      "title": "UserRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/userread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/userread/index.md",
      "file": "api/models/userread/index.md",
      "searchText": "name UserRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:UserRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/userread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/userread/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookattemptread/index.md",
      "kind": "schema",
      "title": "WebhookAttemptRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptread/index.md",
      "file": "api/models/webhookattemptread/index.md",
      "searchText": "name WebhookAttemptRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_attempts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  required 0 type 1 id 2 attributes",
      "documentId": "schema:WebhookAttemptRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptread/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookattemptsingle/index.md",
      "kind": "schema",
      "title": "WebhookAttemptSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptsingle/index.md",
      "file": "api/models/webhookattemptsingle/index.md",
      "searchText": "name WebhookAttemptSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttemptRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_attempts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:WebhookAttemptSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookattemptsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattemptsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookmessageread/index.md",
      "kind": "schema",
      "title": "WebhookMessageRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessageread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessageread/index.md",
      "file": "api/models/webhookmessageread/index.md",
      "searchText": "name WebhookMessageRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_messages examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName  required 0 type 1 id 2 attributes",
      "documentId": "schema:WebhookMessageRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessageread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessageread/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookmessagesingle/index.md",
      "kind": "schema",
      "title": "WebhookMessageSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessagesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessagesingle/index.md",
      "file": "api/models/webhookmessagesingle/index.md",
      "searchText": "name WebhookMessageSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessageRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhook_messages examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName  required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:WebhookMessageSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessagesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessagesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookread/index.md",
      "kind": "schema",
      "title": "WebhookRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookread/index.md",
      "file": "api/models/webhookread/index.md",
      "searchText": "name WebhookRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:WebhookRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookread/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhooksingle/index.md",
      "kind": "schema",
      "title": "WebhookSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhooksingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooksingle/index.md",
      "file": "api/models/webhooksingle/index.md",
      "searchText": "name WebhookSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example webhooks examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:WebhookSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhooksingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooksingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountproperties/index.md",
      "kind": "schema",
      "title": "AccountProperties",
      "description": "Fields: created_at, updated_at, active, order, name, type and 42 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountproperties/index.md",
      "file": "api/models/accountproperties/index.md",
      "searchText": "name AccountProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type",
      "documentId": "schema:AccountProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountread/index.md",
      "kind": "schema",
      "title": "AccountRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountread/index.md",
      "file": "api/models/accountread/index.md",
      "searchText": "name AccountRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes",
      "documentId": "schema:AccountRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountread/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountsingle/index.md",
      "kind": "schema",
      "title": "AccountSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountsingle/index.md",
      "file": "api/models/accountsingle/index.md",
      "searchText": "name AccountSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example accounts examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account. Is NULL if account is not asset or liability. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  current_balance name  type string format amount title  description The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_balance name  type string format amount title  description The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_balance_difference name  type string format amount title  description If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_opening_balance name  type string format amount title  description The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  virtual_balance name  type string format amount title  description The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_virtual_balance name  type string format amount title  description The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  pc_debt_amount name  type string format amount title  description In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1012.12 examples  refName  current_balance_date name  type string format date-time title  description The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty include_net_worth name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  last_activity name  type string format date-time title  description Last activity of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  required 0 name 1 type required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:AccountSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountstore/index.md",
      "kind": "schema",
      "title": "AccountStore",
      "description": "Fields: name, type, iban, bic, account_number, opening_balance and 18 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountstore/index.md",
      "file": "api/models/accountstore/index.md",
      "searchText": "name AccountStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  type name  type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description Represents the opening balance, the initial amount this account holds. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description Represents the date of the opening balance. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty liability_direction name  type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default 0 enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the accounts's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type",
      "documentId": "schema:AccountStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountupdate/index.md",
      "kind": "schema",
      "title": "AccountUpdate",
      "description": "Fields: name, iban, bic, account_number, opening_balance, opening_balance_date and 16 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountupdate/index.md",
      "file": "api/models/accountupdate/index.md",
      "searchText": "name AccountUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My checking account examples  refName  iban name  type string format iban title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GB98MIDL07009312345678 examples  refName  bic name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BOFAUS3N examples  refName  account_number name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7009312345678 examples  refName  opening_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  opening_balance_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  virtual_balance name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  active name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the account default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  include_net_worth name  type boolean format  title  description If omitted, defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  account_role name  type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty credit_card_type name  type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty monthly_payment_date name  type string format date-time title  description Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  liability_type name  type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty interest name  type string format string title  description Mandatory when type is liability. Interest percentage. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.3 examples  refName  interest_period name  type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  latitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 name 1 type",
      "documentId": "schema:AccountUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/arrayentrywithcurrencyandsum/index.md",
      "kind": "schema",
      "title": "ArrayEntryWithCurrencyAndSum",
      "description": "Fields: currency_id, currency_code, currency_symbol, currency_decimal_places and sum.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md",
      "file": "api/models/arrayentrywithcurrencyandsum/index.md",
      "searchText": "name ArrayEntryWithCurrencyAndSum type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName ",
      "documentId": "schema:ArrayEntryWithCurrencyAndSum",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/arrayentrywithcurrencyandsum/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentproperties/index.md",
      "kind": "schema",
      "title": "AttachmentProperties",
      "description": "Fields: created_at, updated_at, attachable_type, attachable_id, hash, filename and 6 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentproperties/index.md",
      "file": "api/models/attachmentproperties/index.md",
      "searchText": "name AttachmentProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName ",
      "documentId": "schema:AttachmentProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentread/index.md",
      "kind": "schema",
      "title": "AttachmentRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentread/index.md",
      "file": "api/models/attachmentread/index.md",
      "searchText": "name AttachmentRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:AttachmentRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentread/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentsingle/index.md",
      "kind": "schema",
      "title": "AttachmentSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentsingle/index.md",
      "file": "api/models/attachmentsingle/index.md",
      "searchText": "name AttachmentSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example attachments examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  hash name  type string format string title  description Hash of the file for basic duplicate detection. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0c3f95f34370baa88f9fd9a671fea305 examples  refName  filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  download_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  upload_url name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/attachments/191/download examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  mime name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example application/pdf examples  refName  size name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 48211 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:AttachmentSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentstore/index.md",
      "kind": "schema",
      "title": "AttachmentStore",
      "description": "Fields: filename, attachable_type, attachable_id, title and notes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentstore/index.md",
      "file": "api/models/attachmentstore/index.md",
      "searchText": "name AttachmentStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentStore properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  attachable_type name  type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType attachable_id name  type string format string title  description ID of the model this attachment is linked to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 134 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  required 0 filename 1 attachable_type 2 attachable_id",
      "documentId": "schema:AttachmentStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachmentupdate/index.md",
      "kind": "schema",
      "title": "AttachmentUpdate",
      "description": "Fields: filename, title and notes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachmentupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentupdate/index.md",
      "file": "api/models/attachmentupdate/index.md",
      "searchText": "name AttachmentUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AttachmentUpdate properties filename name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example file.pdf examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some PDF file examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName ",
      "documentId": "schema:AttachmentUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachmentupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachmentupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/availablebudgetproperties/index.md",
      "kind": "schema",
      "title": "AvailableBudgetProperties",
      "description": "Fields: created_at, updated_at, object_has_currency_setting, currency_id, currency_name, currency_code and 15 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetproperties/index.md",
      "file": "api/models/availablebudgetproperties/index.md",
      "searchText": "name AvailableBudgetProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName ",
      "documentId": "schema:AvailableBudgetProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/availablebudgetread/index.md",
      "kind": "schema",
      "title": "AvailableBudgetRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetread/index.md",
      "file": "api/models/availablebudgetread/index.md",
      "searchText": "name AvailableBudgetRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes",
      "documentId": "schema:AvailableBudgetRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetread/index.md"
        }
      ]
    },
    {
      "id": "api/models/availablebudgetsingle/index.md",
      "kind": "schema",
      "title": "AvailableBudgetSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetsingle/index.md",
      "file": "api/models/availablebudgetsingle/index.md",
      "searchText": "name AvailableBudgetSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example available_budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AvailableBudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount of this available budget in the currency of this available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this available budget in the primary currency (pc) of this administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start name  type string format date-time title  description Start date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the available budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  spent_in_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_in_budgets name  type array format  title  description The amount spent in budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent_outside_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent_outside_budgets name  type array format  title  description The amount spent outside of budgets in the primary currency (pc) of this administration.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:AvailableBudgetSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/availablebudgetsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/availablebudgetsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/billproperties/index.md",
      "kind": "schema",
      "title": "BillProperties",
      "description": "Fields: created_at, updated_at, name, object_has_currency_setting, currency_id, currency_name and 29 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billproperties/index.md",
      "file": "api/models/billproperties/index.md",
      "searchText": "name BillProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName ",
      "documentId": "schema:BillProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/billread/index.md",
      "kind": "schema",
      "title": "BillRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billread/index.md",
      "file": "api/models/billread/index.md",
      "searchText": "name BillRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes",
      "documentId": "schema:BillRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billread/index.md"
        }
      ]
    },
    {
      "id": "api/models/billsingle/index.md",
      "kind": "schema",
      "title": "BillSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billsingle/index.md",
      "file": "api/models/billsingle/index.md",
      "searchText": "name BillSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example bills examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description The name of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_min name  type string format amount title  description The minimum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_max name  type string format amount title  description The maximum amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount_avg name  type string format amount title  description The average amount that is expected for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this subscription is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the subscription must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the subscription will be skipped. 1 means a bi-monthly subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the subscription is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  paid_dates name  type array format  title  description Array of past transactions when the subscription was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties transaction_group_id name  type string format string title  description Transaction group ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  transaction_journal_id name  type string format string title  description Transaction journal ID of the transaction linked to this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  date name  type string format date-time title  description Date the bill was paid. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  subscription_id name  type string format string title  description ID of this subscription. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description The amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the subscription's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description The foreign amount that was paid for this subscription in the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pay_dates name  type array format  title  description Array of future dates when the bill is expected to be paid. Autogenerated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match name  type string format date-time title  description When the subscription is expected to be due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  next_expected_match_diff name  type string format string title  description Formatted (locally) when the subscription is due. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example today examples  refName  required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:BillSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/billstore/index.md",
      "kind": "schema",
      "title": "BillStore",
      "description": "Fields: currency_id, currency_code, name, amount_min, amount_max, date and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billstore/index.md",
      "file": "api/models/billstore/index.md",
      "searchText": "name BillStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillStore properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 amount_min 2 amount_max 3 date 4 repeat_freq",
      "documentId": "schema:BillStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/billupdate/index.md",
      "kind": "schema",
      "title": "BillUpdate",
      "description": "Fields: currency_id, currency_code, name, amount_min, amount_max, date and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billupdate/index.md",
      "file": "api/models/billupdate/index.md",
      "searchText": "name BillUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BillUpdate properties currency_id name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  amount_min name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  amount_max name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end_date name  type string format date-time title  description The date after which this bill is no longer valid or applicable default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  extension_date name  type string format date-time title  description The date before which the bill must be renewed (or cancelled) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  repeat_freq name  type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency skip name  type integer format int32 title  description How often the bill must be skipped. 1 means a bi-monthly bill. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  active name  type boolean format  title  description If the bill is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name",
      "documentId": "schema:BillUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetproperties/index.md",
      "kind": "schema",
      "title": "BudgetProperties",
      "description": "Fields: created_at, updated_at, active, name, order, notes and 20 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetproperties/index.md",
      "file": "api/models/budgetproperties/index.md",
      "searchText": "name BudgetProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name",
      "documentId": "schema:BudgetProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetread/index.md",
      "kind": "schema",
      "title": "BudgetRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetread/index.md",
      "file": "api/models/budgetread/index.md",
      "searchText": "name BudgetRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes",
      "documentId": "schema:BudgetRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetread/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetsingle/index.md",
      "kind": "schema",
      "title": "BudgetSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetsingle/index.md",
      "file": "api/models/budgetsingle/index.md",
      "searchText": "name BudgetSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budgets examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  pc_auto_budget_amount name  type string format amount title  description The amount for the auto-budget, if set in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Information on how much was spent in this budget. Is only filled in when the start and end date are submitted. It is converted to the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:BudgetSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetstore/index.md",
      "kind": "schema",
      "title": "BudgetStore",
      "description": "Fields: name, active, order, notes, fire_webhooks, auto_budget_type and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetstore/index.md",
      "file": "api/models/budgetstore/index.md",
      "searchText": "name BudgetStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name",
      "documentId": "schema:BudgetStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetupdate/index.md",
      "kind": "schema",
      "title": "BudgetUpdate",
      "description": "Fields: name, active, order, notes, fire_webhooks, auto_budget_type and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetupdate/index.md",
      "file": "api/models/budgetupdate/index.md",
      "searchText": "name BudgetUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  auto_budget_type name  type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType auto_budget_currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  auto_budget_currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's financial administration's currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  auto_budget_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  auto_budget_period name  type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod required 0 name",
      "documentId": "schema:BudgetUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitproperties/index.md",
      "kind": "schema",
      "title": "BudgetLimitProperties",
      "description": "Fields: created_at, updated_at, start, end, budget_id, object_has_currency_setting and 16 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitproperties/index.md",
      "file": "api/models/budgetlimitproperties/index.md",
      "searchText": "name BudgetLimitProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName ",
      "documentId": "schema:BudgetLimitProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitread/index.md",
      "kind": "schema",
      "title": "BudgetLimitRead",
      "description": "Fields: type, id and attributes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitread/index.md",
      "file": "api/models/budgetlimitread/index.md",
      "searchText": "name BudgetLimitRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes",
      "documentId": "schema:BudgetLimitRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitread/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitsingle/index.md",
      "kind": "schema",
      "title": "BudgetLimitSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitsingle/index.md",
      "file": "api/models/budgetlimitsingle/index.md",
      "searchText": "name BudgetLimitSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example budget_limits examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 type 1 id 2 attributes required 0 data",
      "documentId": "schema:BudgetLimitSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitstore/index.md",
      "kind": "schema",
      "title": "BudgetLimitStore",
      "description": "Fields: currency_id, currency_code, budget_id, start, period, end and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitstore/index.md",
      "file": "api/models/budgetlimitstore/index.md",
      "searchText": "name BudgetLimitStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitStore properties currency_id name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description Use either currency_id or currency_code. Defaults to the user's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  start name  type string format date title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  end name  type string format date title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 start 2 end 3 budget_id",
      "documentId": "schema:BudgetLimitStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/budgetlimitupdate/index.md",
      "kind": "schema",
      "title": "BudgetLimitUpdate",
      "description": "Fields: created_at, updated_at, start, end, budget_id, object_has_currency_setting and 16 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitupdate/index.md",
      "file": "api/models/budgetlimitupdate/index.md",
      "searchText": "name BudgetLimitUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BudgetLimitUpdate properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  start name  type string format date-time title  description Start date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  end name  type string format date-time title  description End date of the budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  budget_id name  type string format string title  description The budget ID of the associated budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 23 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  period name  type string format string title  description Period of the budget limit. Only used when auto-generated by auto-budget. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description The amount of this budget limit in the user's primary currency, if the original amount is in a different currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  spent name  type string format amount title  description Will be in the primary currency if this is turned on by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example -1012.12 examples  refName  notes name  type string format string title  description Some notes for this specific budget limit. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:BudgetLimitUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/budgetlimitupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/budgetlimitupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/categoryproperties/index.md",
      "kind": "schema",
      "title": "CategoryProperties",
      "description": "Fields: created_at, updated_at, name, color, last_activity, notes and 12 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categoryproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryproperties/index.md",
      "file": "api/models/categoryproperties/index.md",
      "searchText": "name CategoryProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  last_activity name  type string format date-time title  description Last activity of the category. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  object_has_currency_setting name  type boolean format  title  description This object never has its own currency setting, so this value is always false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  spent name  type array format  title  description Amount(s) spent in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_spent name  type array format  title  description Amount(s) spent in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  earned name  type array format  title  description Amount(s) earned in the currencies in the database for this category. ONLY present when start and date are set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_earned name  type array format  title  description Amount(s) earned in the primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  transferred name  type array format  title  description Amount(s) transferred in the currencies in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_transferred name  type array format  title  description Amount(s) transferred in primary currency in the database for this category. ONLY present when start and date are set.  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ArrayEntryWithCurrencyAndSum properties currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals supported by the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  sum name  type string format amount title  description The amount earned, spent or transferred. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 name",
      "documentId": "schema:CategoryProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categoryproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/categorystore/index.md",
      "kind": "schema",
      "title": "CategoryStore",
      "description": "Fields: name, notes and color.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categorystore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categorystore/index.md",
      "file": "api/models/categorystore/index.md",
      "searchText": "name CategoryStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name",
      "documentId": "schema:CategoryStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categorystore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categorystore/index.md"
        }
      ]
    },
    {
      "id": "api/models/categoryupdate/index.md",
      "kind": "schema",
      "title": "CategoryUpdate",
      "description": "Fields: name, notes and color.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/categoryupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryupdate/index.md",
      "file": "api/models/categoryupdate/index.md",
      "searchText": "name CategoryUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CategoryUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Lunch examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  color name  type string format string title  description The color of the category in HEX format. Firefly III does not use this field, but your app might. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example FF0000 examples  refName  required 0 name",
      "documentId": "schema:CategoryUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/categoryupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/categoryupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeproperties/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeProperties",
      "description": "Fields: created_at, updated_at, from_currency_id, from_currency_name, from_currency_code, from_currency_symbol and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeproperties/index.md",
      "file": "api/models/currencyexchangeproperties/index.md",
      "searchText": "name CurrencyExchangeProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName ",
      "documentId": "schema:CurrencyExchangeProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangerateread/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateread/index.md",
      "file": "api/models/currencyexchangerateread/index.md",
      "searchText": "name CurrencyExchangeRateRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName ",
      "documentId": "schema:CurrencyExchangeRateRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateread/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeratesingle/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratesingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratesingle/index.md",
      "file": "api/models/currencyexchangeratesingle/index.md",
      "searchText": "name CurrencyExchangeRateSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currency_exchange_rates examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  from_currency_id name  type string format string title  description Base currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  from_currency_name name  type string format string title  description Base currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  from_currency_code name  type string format string title  description Base currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  from_currency_symbol name  type string format string title  description Base currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  from_currency_decimal_places name  type integer format int32 title  description Base currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  to_currency_id name  type string format string title  description Destination currency ID for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  to_currency_name name  type string format string title  description Destination currency name for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_code name  type string format string title  description Destination currency code for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  to_currency_symbol name  type string format string title  description Destination currency symbol for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  to_currency_decimal_places name  type integer format int32 title  description Destination currency decimal places for this exchange rate entry. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  rate name  type string format string title  description The actual exchange rate. How many 'to' currency will you get for 1 'from' currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1.10340 examples  refName  date name  type string format date-time title  description Date and time of the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 data",
      "documentId": "schema:CurrencyExchangeRateSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratesingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratesingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeratestore/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateStore",
      "description": "Fields: date, from, to and rate.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestore/index.md",
      "file": "api/models/currencyexchangeratestore/index.md",
      "searchText": "name CurrencyExchangeRateStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateStore properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  required 0 date 1 from 2 to 3 rates",
      "documentId": "schema:CurrencyExchangeRateStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestore/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeratestorebydate/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateStoreByDate",
      "description": "Fields: from and rates.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebydate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebydate/index.md",
      "file": "api/models/currencyexchangeratestorebydate/index.md",
      "searchText": "name CurrencyExchangeRateStoreByDate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateStoreByDate properties from name  type string format string title  description The 'from'-currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  rates name  type object format  title  description The actual entries for this data set. They 'key' value is 'to' currency. The value is the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD 1.2345 GBP 6.3456 examples  refName  additionalProperties name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 from 1 date 2 rates",
      "documentId": "schema:CurrencyExchangeRateStoreByDate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebydate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebydate/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangeratestorebypair/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateStoreByPair",
      "description": "The actual entries for this data set. They 'key' value is the date in YYYY-MM-DD. The value is the exchange rate.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebypair/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebypair/index.md",
      "file": "api/models/currencyexchangeratestorebypair/index.md",
      "searchText": "name CurrencyExchangeRateStoreByPair type object format  title  description The actual entries for this data set. They 'key' value is the date in YYYY-MM-DD. The value is the exchange rate. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2025-08-01 1.2345 2025-08-02 6.3456 examples  refName CurrencyExchangeRateStoreByPair additionalProperties name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:CurrencyExchangeRateStoreByPair",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebypair/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangeratestorebypair/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangerateupdate/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateUpdate",
      "description": "Fields: date, rate, from and to.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdate/index.md",
      "file": "api/models/currencyexchangerateupdate/index.md",
      "searchText": "name CurrencyExchangeRateUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdate properties date name  type string format date title  description The date to which the exchange rate is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  from name  type string format string title  description The base currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  to name  type string format string title  description The destination currency code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 date 1 rate",
      "documentId": "schema:CurrencyExchangeRateUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyexchangerateupdatenodate/index.md",
      "kind": "schema",
      "title": "CurrencyExchangeRateUpdateNoDate",
      "description": "Field: rate.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdatenodate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdatenodate/index.md",
      "file": "api/models/currencyexchangerateupdatenodate/index.md",
      "searchText": "name CurrencyExchangeRateUpdateNoDate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyExchangeRateUpdateNoDate properties rate name  type string format string title  description The exchange rate from the base currency to the destination currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2.3456 examples  refName  required 0 rate",
      "documentId": "schema:CurrencyExchangeRateUpdateNoDate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdatenodate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyexchangerateupdatenodate/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectgroup/index.md",
      "kind": "schema",
      "title": "ObjectGroup",
      "description": "Fields: created_at, updated_at, title and order.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectgroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroup/index.md",
      "file": "api/models/objectgroup/index.md",
      "searchText": "name ObjectGroup type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title 1 order",
      "documentId": "schema:ObjectGroup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectgroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroup/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectgroupupdate/index.md",
      "kind": "schema",
      "title": "ObjectGroupUpdate",
      "description": "Fields: title and order.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupupdate/index.md",
      "file": "api/models/objectgroupupdate/index.md",
      "searchText": "name ObjectGroupUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example My object group examples  refName  order name  type integer format int32 title  description Order of the object group default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 title",
      "documentId": "schema:ObjectGroupUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectgroupupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectgroupupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/objectlink/index.md",
      "kind": "schema",
      "title": "ObjectLink",
      "description": "Fields: 0 and self.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/objectlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/objectlink/index.md",
      "file": "api/models/objectlink/index.md",
      "searchText": "name ObjectLink type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName ",
      "documentId": "schema:ObjectLink",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/objectlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/objectlink/index.md"
        }
      ]
    },
    {
      "id": "api/models/pagelink/index.md",
      "kind": "schema",
      "title": "PageLink",
      "description": "Fields: self, first, next, prev and last.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/pagelink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/pagelink/index.md",
      "file": "api/models/pagelink/index.md",
      "searchText": "name PageLink type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PageLink properties self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=4 examples  refName  first name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=1 examples  refName  next name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=3 examples  refName  prev name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=2 examples  refName  last name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECT?&page=12 examples  refName ",
      "documentId": "schema:PageLink",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/pagelink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/pagelink/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankaccountread/index.md",
      "kind": "schema",
      "title": "PiggyBankAccountRead",
      "description": "Fields: account_id, name, current_amount and pc_current_amount.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/index.md",
      "file": "api/models/piggybankaccountread/index.md",
      "searchText": "name PiggyBankAccountRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName ",
      "documentId": "schema:PiggyBankAccountRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountread/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankaccountstore/index.md",
      "kind": "schema",
      "title": "PiggyBankAccountStore",
      "description": "Fields: id, name and current_amount.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/index.md",
      "file": "api/models/piggybankaccountstore/index.md",
      "searchText": "name PiggyBankAccountStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountStore properties id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id",
      "documentId": "schema:PiggyBankAccountStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankaccountupdate/index.md",
      "kind": "schema",
      "title": "PiggyBankAccountUpdate",
      "description": "Fields: account_id, name and current_amount.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountupdate/index.md",
      "file": "api/models/piggybankaccountupdate/index.md",
      "searchText": "name PiggyBankAccountUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountUpdate properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id",
      "documentId": "schema:PiggyBankAccountUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankaccountupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankproperties/index.md",
      "kind": "schema",
      "title": "PiggyBankProperties",
      "description": "Fields: created_at, updated_at, name, percentage, start_date, target_date and 26 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankproperties/index.md",
      "file": "api/models/piggybankproperties/index.md",
      "searchText": "name PiggyBankProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  percentage name  type integer format int32 title  description The percentage of the target amount that has been saved, if a target amount is set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  start_date name  type string format date-time title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  target_date name  type string format date-time title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_order name  type integer format int32 title  description The order of the group. At least 1, for the highest sorting. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountRead properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description If convertToPrimary is on, this will show the amount in the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_target_amount name  type string format amount title  description The target amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_current_amount name  type string format amount title  description The current amount in the primary currency of the administration. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  pc_left_to_save name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 700.00 examples  refName  save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  pc_save_per_month name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12.45 examples  refName  required 0 name 1 account_id 2 target_amount",
      "documentId": "schema:PiggyBankProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankstore/index.md",
      "kind": "schema",
      "title": "PiggyBankStore",
      "description": "Fields: name, accounts, target_amount, current_amount, start_date, target_date and 5 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankstore/index.md",
      "file": "api/models/piggybankstore/index.md",
      "searchText": "name PiggyBankStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankStore properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountStore properties id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  current_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName  required 0 name 1 account_id 2 target_amount 3 start_date",
      "documentId": "schema:PiggyBankStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankupdate/index.md",
      "kind": "schema",
      "title": "PiggyBankUpdate",
      "description": "Fields: name, accounts, currency_id, currency_code, target_amount, start_date and 6 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankupdate/index.md",
      "file": "api/models/piggybankupdate/index.md",
      "searchText": "name PiggyBankUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New digital camera examples  refName  accounts name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankAccountUpdate properties account_id name  type string format string title  description The ID of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  name name  type string format string title  description The name of the account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  current_amount name  type string format amount title  description The amount saved currently. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  required 0 id currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  target_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  start_date name  type string format date title  description The date you started with this piggy bank. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  target_date name  type string format date title  description The date you intend to finish saving money. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  object_group_id name  type string format string title  description The group ID of the group this object is part of. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  object_group_title name  type string format string title  description The name of the group. NULL if no group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Example Group examples  refName ",
      "documentId": "schema:PiggyBankUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/piggybankeventproperties/index.md",
      "kind": "schema",
      "title": "PiggyBankEventProperties",
      "description": "Fields: created_at, updated_at, amount, pc_amount, object_has_currency_setting, currency_id and 11 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventproperties/index.md",
      "file": "api/models/piggybankeventproperties/index.md",
      "searchText": "name PiggyBankEventProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PiggyBankEventProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  transaction_journal_id name  type string format string title  description The journal associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName  transaction_group_id name  type string format string title  description The transaction group associated with the event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4291 examples  refName ",
      "documentId": "schema:PiggyBankEventProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/piggybankeventproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/piggybankeventproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/preference/index.md",
      "kind": "schema",
      "title": "Preference",
      "description": "Fields: created_at, updated_at, name and data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/preference/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/preference/index.md",
      "file": "api/models/preference/index.md",
      "searchText": "name Preference type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Preference properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example currencyPreference examples  refName  data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 name 1 data",
      "documentId": "schema:Preference",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/preference/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/preference/index.md"
        }
      ]
    },
    {
      "id": "api/models/preferenceupdate/index.md",
      "kind": "schema",
      "title": "PreferenceUpdate",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/preferenceupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/preferenceupdate/index.md",
      "file": "api/models/preferenceupdate/index.md",
      "searchText": "name PreferenceUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PreferenceUpdate properties data name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 data",
      "documentId": "schema:PreferenceUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/preferenceupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/preferenceupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrenceproperties/index.md",
      "kind": "schema",
      "title": "RecurrenceProperties",
      "description": "Fields: created_at, updated_at, type, title, description, first_date and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceproperties/index.md",
      "file": "api/models/recurrenceproperties/index.md",
      "searchText": "name RecurrenceProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  latest_date name  type string format date title  description Last time the recurring transaction has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount",
      "documentId": "schema:RecurrenceProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencestore/index.md",
      "kind": "schema",
      "title": "RecurrenceStore",
      "description": "Fields: type, title, description, first_date, repeat_until, nr_of_repetitions and 5 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencestore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencestore/index.md",
      "file": "api/models/recurrencestore/index.md",
      "searchText": "name RecurrenceStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceStore properties type name  type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. Must be after today. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until the recurring transaction can fire. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionStore properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 type 1 moment transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionStore properties description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 description 1 amount 2 source_id 3 destination_id required 0 type 1 title 2 first_date 3 repeat_until 4 repetitions 5 transactions",
      "documentId": "schema:RecurrenceStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencestore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencestore/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrenceupdate/index.md",
      "kind": "schema",
      "title": "RecurrenceUpdate",
      "description": "Fields: title, description, first_date, repeat_until, nr_of_repetitions, apply_rules and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceupdate/index.md",
      "file": "api/models/recurrenceupdate/index.md",
      "searchText": "name RecurrenceUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent examples  refName  description name  type string format string title  description Not to be confused with the description of the actual transaction(s) being created. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Recurring transaction for the monthly rent examples  refName  first_date name  type string format date title  description First time the recurring transaction will fire. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  repeat_until name  type string format date title  description Date until when the recurring transaction can fire. After that date, it's basically inactive. Use either this field or repetitions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31 examples  refName  nr_of_repetitions name  type integer format int32 title  description Max number of created transactions. Use either this field or repeat_until. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  apply_rules name  type boolean format  title  description Whether or not to fire the rules after the creation of a transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  active name  type boolean format  title  description If the recurrence is even active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some notes examples  refName  repetitions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionUpdate properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionUpdate properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 id",
      "documentId": "schema:RecurrenceUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrenceupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrenceupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencerepetition/index.md",
      "kind": "schema",
      "title": "RecurrenceRepetition",
      "description": "Fields: id, created_at, updated_at, type, moment, skip and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetition/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetition/index.md",
      "file": "api/models/recurrencerepetition/index.md",
      "searchText": "name RecurrenceRepetition type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetition properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  description name  type string format string title  description Auto-generated repetition description. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Every week on Friday examples  refName  occurrences name  type array format  title  description Array of future dates when the repetition will apply to. Auto generated. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-31T23:59:59+00:00 examples  refName  required 0 type 1 moment",
      "documentId": "schema:RecurrenceRepetition",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetition/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetition/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencerepetitionstore/index.md",
      "kind": "schema",
      "title": "RecurrenceRepetitionStore",
      "description": "Fields: type, moment, skip and weekend.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionstore/index.md",
      "file": "api/models/recurrencerepetitionstore/index.md",
      "searchText": "name RecurrenceRepetitionStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionStore properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  required 0 type 1 moment",
      "documentId": "schema:RecurrenceRepetitionStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencerepetitionupdate/index.md",
      "kind": "schema",
      "title": "RecurrenceRepetitionUpdate",
      "description": "Fields: type, moment, skip and weekend.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionupdate/index.md",
      "file": "api/models/recurrencerepetitionupdate/index.md",
      "searchText": "name RecurrenceRepetitionUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceRepetitionUpdate properties type name  type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType moment name  type string format string title  description Information that defined the type of repetition.\n- For 'daily', this is empty.\n- For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday).\n- For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month\n- For 'monthly' it is the day of the month (1 - 31)\n- For yearly, it is a full date, ie '2026-10-01'. The year you use does not matter.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  skip name  type integer format int32 title  description How many occurrences to skip. 0 means skip nothing. 1 means every other. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  weekend name  type integer format int32 title  description How to respond when the recurring transaction falls in the weekend. Possible values:\n1. Do nothing, just create it\n2. Create no transaction.\n3. Skip to the previous Friday.\n4. Skip to the next Monday.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName ",
      "documentId": "schema:RecurrenceRepetitionUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitionupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencetransaction/index.md",
      "kind": "schema",
      "title": "RecurrenceTransaction",
      "description": "Fields: id, description, object_has_currency_setting, currency_id, currency_name, currency_code and 33 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransaction/index.md",
      "file": "api/models/recurrencetransaction/index.md",
      "searchText": "name RecurrenceTransaction type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransaction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the object has a currency setting. If false, the object uses the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description The currency ID of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_name name  type string format string title  description The currency name of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_code name  type string format string title  description The currency code of the currency associated with this object. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description The currency ID of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  primary_currency_name name  type string format string title  description The currency name of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  primary_currency_code name  type string format string title  description The currency code of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description The currency symbol of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description The currency decimal places of the administration's primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example British Pound examples  refName  foreign_currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  category_name name  type string format string title  description Category name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bills examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  source_name name  type string format string title  description Name of the source account. Submit either this or source_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  destination_name name  type string format string title  description Name of the destination account. Submit either this or destination_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  piggy_bank_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  subscription_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  subscription_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 description 1 amount",
      "documentId": "schema:RecurrenceTransaction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransaction/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencetransactionstore/index.md",
      "kind": "schema",
      "title": "RecurrenceTransactionStore",
      "description": "Fields: description, amount, foreign_amount, currency_id, currency_code, foreign_currency_id and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionstore/index.md",
      "file": "api/models/recurrencetransactionstore/index.md",
      "searchText": "name RecurrenceTransactionStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionStore properties description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example GBP examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 description 1 amount 2 source_id 3 destination_id",
      "documentId": "schema:RecurrenceTransactionStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencetransactionupdate/index.md",
      "kind": "schema",
      "title": "RecurrenceTransactionUpdate",
      "description": "Fields: id, description, amount, foreign_amount, currency_id, currency_code and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionupdate/index.md",
      "file": "api/models/recurrencetransactionupdate/index.md",
      "searchText": "name RecurrenceTransactionUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RecurrenceTransactionUpdate properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Rent for the current month examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description Foreign amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  currency_code name  type string format string title  description Submit either a currency_id or a currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_currency_id name  type string format string title  description Submit either a foreign_currency_id or a foreign_currency_code, or neither. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  category_id name  type string format string title  description Category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 211 examples  refName  source_id name  type string format string title  description ID of the source account. Submit either this or source_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 913 examples  refName  destination_id name  type string format string title  description ID of the destination account. Submit either this or destination_name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 258 examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  piggy_bank_id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  bill_id name  type string format string title  description Optional. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  required 0 id",
      "documentId": "schema:RecurrenceTransactionUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactionupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/rule/index.md",
      "kind": "schema",
      "title": "Rule",
      "description": "Fields: created_at, updated_at, title, description, rule_group_id, rule_group_title and 7 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rule/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rule/index.md",
      "file": "api/models/rule/index.md",
      "searchText": "name Rule type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Rule properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions",
      "documentId": "schema:Rule",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rule/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rule/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulestore/index.md",
      "kind": "schema",
      "title": "RuleStore",
      "description": "Fields: title, description, rule_group_id, rule_group_title, order, trigger and 5 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulestore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulestore/index.md",
      "file": "api/models/rulestore/index.md",
      "searchText": "name RuleStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  rule_group_title name  type string format string title  description Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerStore properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionStore properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value required 0 title 1 rule_group_id 2 trigger 3 triggers 4 actions",
      "documentId": "schema:RuleStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulestore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulestore/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleupdate/index.md",
      "kind": "schema",
      "title": "RuleUpdate",
      "description": "Fields: title, description, rule_group_id, order, trigger, active and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleupdate/index.md",
      "file": "api/models/ruleupdate/index.md",
      "searchText": "name RuleUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule title. examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example First rule description examples  refName  rule_group_id name  type string format string title  description ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 81 examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  trigger name  type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType active name  type boolean format  title  description Whether or not the rule is even active. Default is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  strict name  type boolean format  title  description If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerUpdate properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. If the rule trigger is something like 'has any tag', submit the string 'true'. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  actions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionUpdate properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:RuleUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleaction/index.md",
      "kind": "schema",
      "title": "RuleAction",
      "description": "Fields: id, created_at, updated_at, type, value, order and 2 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleaction/index.md",
      "file": "api/models/ruleaction/index.md",
      "searchText": "name RuleAction type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleAction properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value",
      "documentId": "schema:RuleAction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleaction/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleactionstore/index.md",
      "kind": "schema",
      "title": "RuleActionStore",
      "description": "Fields: type, value, order, active and stop_processing.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionstore/index.md",
      "file": "api/models/ruleactionstore/index.md",
      "searchText": "name RuleActionStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionStore properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value",
      "documentId": "schema:RuleActionStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleactionupdate/index.md",
      "kind": "schema",
      "title": "RuleActionUpdate",
      "description": "Fields: type, value, order, active and stop_processing.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionupdate/index.md",
      "file": "api/models/ruleactionupdate/index.md",
      "searchText": "name RuleActionUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleActionUpdate properties type name  type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword value name  type string format string title  description The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Daily groceries examples  refName  order name  type integer format int32 title  description Order of the action default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the action is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other actions will not be fired after this action has fired. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:RuleActionUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegroup/index.md",
      "kind": "schema",
      "title": "RuleGroup",
      "description": "Fields: created_at, updated_at, title, description, order and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegroup/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroup/index.md",
      "file": "api/models/rulegroup/index.md",
      "searchText": "name RuleGroup type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroup properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title",
      "documentId": "schema:RuleGroup",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegroup/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroup/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegroupstore/index.md",
      "kind": "schema",
      "title": "RuleGroupStore",
      "description": "Fields: title, description, order and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupstore/index.md",
      "file": "api/models/rulegroupstore/index.md",
      "searchText": "name RuleGroupStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupStore properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title",
      "documentId": "schema:RuleGroupStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/rulegroupupdate/index.md",
      "kind": "schema",
      "title": "RuleGroupUpdate",
      "description": "Fields: title, description, order and active.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupupdate/index.md",
      "file": "api/models/rulegroupupdate/index.md",
      "searchText": "name RuleGroupUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleGroupUpdate properties title name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Default rule group examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Description of this rule group examples  refName  order name  type integer format int32 title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  active name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:RuleGroupUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/rulegroupupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/rulegroupupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruletrigger/index.md",
      "kind": "schema",
      "title": "RuleTrigger",
      "description": "Fields: id, created_at, updated_at, type, value, prohibited and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruletrigger/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletrigger/index.md",
      "file": "api/models/ruletrigger/index.md",
      "searchText": "name RuleTrigger type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTrigger properties id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value",
      "documentId": "schema:RuleTrigger",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruletrigger/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletrigger/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruletriggerstore/index.md",
      "kind": "schema",
      "title": "RuleTriggerStore",
      "description": "Fields: type, value, order, active, prohibited and stop_processing.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerstore/index.md",
      "file": "api/models/ruletriggerstore/index.md",
      "searchText": "name RuleTriggerStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerStore properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. Defaults to true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  prohibited name  type boolean format  title  description If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. Defaults to false. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 type 1 value",
      "documentId": "schema:RuleTriggerStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruletriggerupdate/index.md",
      "kind": "schema",
      "title": "RuleTriggerUpdate",
      "description": "Fields: type, value, order, active and stop_processing.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerupdate/index.md",
      "file": "api/models/ruletriggerupdate/index.md",
      "searchText": "name RuleTriggerUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName RuleTriggerUpdate properties type name  type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword value name  type string format string title  description The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. If the rule trigger is something like 'has any tag', submit the string 'true'. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example tag1 examples  refName  order name  type integer format int32 title  description Order of the trigger default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  active name  type boolean format  title  description If the trigger is active. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  stop_processing name  type boolean format  title  description When true, other triggers will not be checked if this trigger was triggered. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:RuleTriggerUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagmodel/index.md",
      "kind": "schema",
      "title": "TagModel",
      "description": "Fields: created_at, updated_at, tag, date, description, latitude and 2 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagmodel/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodel/index.md",
      "file": "api/models/tagmodel/index.md",
      "searchText": "name TagModel type object format  title A single tag (C) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModel properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag",
      "documentId": "schema:TagModel",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagmodel/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodel/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagmodelstore/index.md",
      "kind": "schema",
      "title": "TagModelStore",
      "description": "Fields: tag, date, description, latitude, longitude and zoom_level.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagmodelstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodelstore/index.md",
      "file": "api/models/tagmodelstore/index.md",
      "searchText": "name TagModelStore type object format  title A single tag (A) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelStore properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  required 0 tag",
      "documentId": "schema:TagModelStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagmodelstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodelstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/tagmodelupdate/index.md",
      "kind": "schema",
      "title": "TagModelUpdate",
      "description": "Fields: tag, date, description, latitude, longitude and zoom_level.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/tagmodelupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodelupdate/index.md",
      "file": "api/models/tagmodelupdate/index.md",
      "searchText": "name TagModelUpdate type object format  title A single tag (B) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TagModelUpdate properties tag name  type string format string title  description The tag default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example expensive examples  refName  date name  type string format date title  description The date to which the tag is applicable. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01 examples  refName  description name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Tag for expensive stuff examples  refName  latitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the tag's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName ",
      "documentId": "schema:TagModelUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/tagmodelupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/tagmodelupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyproperties/index.md",
      "kind": "schema",
      "title": "CurrencyProperties",
      "description": "Fields: created_at, updated_at, enabled, primary, code, name and 2 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyproperties/index.md",
      "file": "api/models/currencyproperties/index.md",
      "searchText": "name CurrencyProperties type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Is the primary currency? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol",
      "documentId": "schema:CurrencyProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencystore/index.md",
      "kind": "schema",
      "title": "CurrencyStore",
      "description": "Fields: enabled, primary, code, name, symbol and decimal_places.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencystore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencystore/index.md",
      "file": "api/models/currencystore/index.md",
      "searchText": "name CurrencyStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyStore properties enabled name  type boolean format  title  description Defaults to true default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description Make this currency the primary currency for the current administration. You can set this value to FALSE, in which case nothing will change to the primary currency. If you set it to TRUE, the current primary currency will no longer be the primary currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description Supports 0-16 decimals. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  required 0 code 1 name 2 symbol",
      "documentId": "schema:CurrencyStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencystore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencystore/index.md"
        }
      ]
    },
    {
      "id": "api/models/currencyupdate/index.md",
      "kind": "schema",
      "title": "CurrencyUpdate",
      "description": "Fields: enabled, primary, code, name, symbol and decimal_places.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/currencyupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyupdate/index.md",
      "file": "api/models/currencyupdate/index.md",
      "searchText": "name CurrencyUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CurrencyUpdate properties enabled name  type boolean format  title  description If the currency is enabled default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  primary name  type boolean format  title  description If the currency must be the primary for the user. You can only submit TRUE. Submitting FALSE will not drop this currency as the primary currency, because then the system would be without one. default  enum 0  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  code name  type string format string title  description The currency code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AMS examples  refName  name name  type string format string title  description The currency name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Ankh-Morpork dollar examples  refName  symbol name  type string format string title  description The currency symbol default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AM$ examples  refName  decimal_places name  type integer format int32 title  description How many decimals to use when displaying this currency. Between 0 and 16. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName ",
      "documentId": "schema:CurrencyUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/currencyupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/currencyupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/transaction/index.md",
      "kind": "schema",
      "title": "Transaction",
      "description": "Fields: created_at, updated_at, user, group_title and transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transaction/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transaction/index.md",
      "file": "api/models/transaction/index.md",
      "searchText": "name Transaction type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Transaction properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type required 0 transactions",
      "documentId": "schema:Transaction",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transaction/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transaction/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionstore/index.md",
      "kind": "schema",
      "title": "TransactionStore",
      "description": "Fields: error_if_duplicate_hash, apply_rules, fire_webhooks, group_title and transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionstore/index.md",
      "file": "api/models/transactionstore/index.md",
      "searchText": "name TransactionStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionStore properties error_if_duplicate_hash name  type boolean format  title  description Break if the submitted transaction exists already. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitStore properties type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_id name  type integer format int32 title  description Optional. Use either this or the piggy_bank_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_name name  type string format string title  description Optional. Use either this or the piggy_bank_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 112 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 date 2 description 3 type required 0 transactions",
      "documentId": "schema:TransactionStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionupdate/index.md",
      "kind": "schema",
      "title": "TransactionUpdate",
      "description": "Fields: apply_rules, fire_webhooks, group_title and transactions.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionupdate/index.md",
      "file": "api/models/transactionupdate/index.md",
      "searchText": "name TransactionUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionUpdate properties apply_rules name  type boolean format  title  description Whether or not to apply rules when submitting transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  fire_webhooks name  type boolean format  title  description Whether or not to fire the webhooks that are related to this event. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  group_title name  type string format string title  description Title of the transaction if it has been split in more than one piece. Empty otherwise. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Split transaction title. examples  refName  transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitUpdate properties transaction_journal_id name  type string format string title  description Transaction journal ID of current transaction (split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:TransactionUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlink/index.md",
      "kind": "schema",
      "title": "TransactionLink",
      "description": "Fields: created_at, updated_at, link_type_id, link_type_name, inward_id, outward_id and 1 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlink/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlink/index.md",
      "file": "api/models/transactionlink/index.md",
      "searchText": "name TransactionLink type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLink properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id",
      "documentId": "schema:TransactionLink",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlink/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlink/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlinkstore/index.md",
      "kind": "schema",
      "title": "TransactionLinkStore",
      "description": "Fields: link_type_id, link_type_name, inward_id, outward_id and notes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkstore/index.md",
      "file": "api/models/transactionlinkstore/index.md",
      "searchText": "name TransactionLinkStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkStore properties link_type_id name  type string format string title  description The link type ID to use. You can also use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. You can also use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  required 0 link_type_id 1 inward_id 2 outward_id",
      "documentId": "schema:TransactionLinkStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionlinkupdate/index.md",
      "kind": "schema",
      "title": "TransactionLinkUpdate",
      "description": "Fields: link_type_id, link_type_name, inward_id, outward_id and notes.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkupdate/index.md",
      "file": "api/models/transactionlinkupdate/index.md",
      "searchText": "name TransactionLinkUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionLinkUpdate properties link_type_id name  type string format string title  description The link type ID to use. Use this field OR use the link_type_name field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  link_type_name name  type string format string title  description The link type name to use. Use this field OR use the link_type_id field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Is paid by examples  refName  inward_id name  type string format string title  description The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  outward_id name  type string format string title  description The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 131 examples  refName  notes name  type string format string title  description Optional. Some notes. If you submit an empty string the current notes will be removed default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName ",
      "documentId": "schema:TransactionLinkUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionlinkupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionlinkupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/linktype/index.md",
      "kind": "schema",
      "title": "LinkType",
      "description": "Fields: name, inward, outward and editable.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/linktype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/linktype/index.md",
      "file": "api/models/linktype/index.md",
      "searchText": "name LinkType type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkType properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName  editable name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 name 1 inward 2 outward",
      "documentId": "schema:LinkType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/linktype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/linktype/index.md"
        }
      ]
    },
    {
      "id": "api/models/linktypeupdate/index.md",
      "kind": "schema",
      "title": "LinkTypeUpdate",
      "description": "Fields: name, inward and outward.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/linktypeupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypeupdate/index.md",
      "file": "api/models/linktypeupdate/index.md",
      "searchText": "name LinkTypeUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName LinkTypeUpdate properties name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Paid examples  refName  inward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example is (partially) paid for by examples  refName  outward name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example (partially) pays for examples  refName ",
      "documentId": "schema:LinkTypeUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/linktypeupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/linktypeupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionsplit/index.md",
      "kind": "schema",
      "title": "TransactionSplit",
      "description": "Fields: user, transaction_journal_id, type, date, order, object_has_currency_setting and 67 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplit/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplit/index.md",
      "file": "api/models/transactionsplit/index.md",
      "searchText": "name TransactionSplit type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplit properties user name  type string format string title  description User ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  transaction_journal_id name  type string format string title  description ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals\nmaking up the splits of the transaction.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 10421 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  object_has_currency_setting name  type boolean format  title  description Indicates whether the transaction has a currency setting. For transactions this is always true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  currency_id name  type string format string title  description Currency ID for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description Currency symbol for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description Currency name for the currency of this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency, if this transaction has a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the administration. This currency is used as the currency for all `pc_*` amount and balance fields of this account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description See the other `primary_*` fields. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_amount name  type string format amount title  description Amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_amount name  type string format amount title  description The amount in the set foreign currency. May be NULL if the transaction does not have a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_foreign_amount name  type string format amount title  description Foreign amount of the transaction in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  source_balance_after name  type string format amount title  description The balance of the source account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_source_balance_after name  type string format amount title  description The balance of the source account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  destination_balance_after name  type string format amount title  description The balance of the destination account. This is the balance in the account's currency which may be different from this transaction, and is not provided in this model. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  pc_destination_balance_after name  type string format amount title  description The balance of the destination account in the primary currency of this administration. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  source_type name  type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_type name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget used. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  bill_id name  type string format string title  description The associated subscription ID for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description The associated subscription name for this transaction. `bill` refers to the OLD name for subscriptions and this field will be removed. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  subscription_id name  type string format string title  description The associated subscription ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  subscription_name name  type string format string title  description The associated subscription name for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  original_source name  type string format string title  description System generated identifier for original creator of transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_id name  type string format string title  description Reference to recurrence that made the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  recurrence_total name  type integer format int32 title  description Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  recurrence_count name  type integer format int32 title  description The # of the current transaction created under this recurrence. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  import_hash_v2 name  type string format string title  description Hash value of original import transaction (for duplicate detection). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  latitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 51.983333 examples  refName  longitude name  type number format double title  description Latitude of the transaction's location, if applicable. Can be used to draw a map. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5.916667 examples  refName  zoom_level name  type integer format int32 title  description Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6 examples  refName  has_attachments name  type boolean format  title  description If the transaction has attachments. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 source_id 2 destination_id 3 date 4 description 5 type",
      "documentId": "schema:TransactionSplit",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplit/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplit/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionsplitstore/index.md",
      "kind": "schema",
      "title": "TransactionSplitStore",
      "description": "Fields: type, date, amount, description, order, currency_id and 36 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplitstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplitstore/index.md",
      "file": "api/models/transactionsplitstore/index.md",
      "searchText": "name TransactionSplitStore type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitStore properties type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. The value you submit may be overruled by the source or destination account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_id name  type integer format int32 title  description Optional. Use either this or the piggy_bank_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  piggy_bank_name name  type string format string title  description Optional. Use either this or the piggy_bank_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 112 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 amount 1 date 2 description 3 type",
      "documentId": "schema:TransactionSplitStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplitstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplitstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactionsplitupdate/index.md",
      "kind": "schema",
      "title": "TransactionSplitUpdate",
      "description": "Fields: transaction_journal_id, type, date, amount, description, order and 42 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplitupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplitupdate/index.md",
      "file": "api/models/transactionsplitupdate/index.md",
      "searchText": "name TransactionSplitUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionSplitUpdate properties transaction_journal_id name  type string format string title  description Transaction journal ID of current transaction (split). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123 examples  refName  type name  type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty date name  type string format date-time title  description Date of the transaction default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  amount name  type string format amount title  description Amount of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  description name  type string format string title  description Description of the transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Vegetables examples  refName  order name  type integer format int32 title  description Order of this entry in the list of transactions. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 examples  refName  currency_id name  type string format string title  description Currency ID. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_code. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  currency_code name  type string format string title  description Currency code. Default is the source account's currency, or the user's financial administration's primary currency. Can be used instead of currency_id. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_name name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Euro examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals used in this currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  foreign_amount name  type string format amount title  description The amount in a foreign currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  foreign_currency_id name  type string format string title  description Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 17 examples  refName  foreign_currency_code name  type string format string title  description Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example USD examples  refName  foreign_currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  foreign_currency_decimal_places name  type integer format int32 title  description Number of decimals in the currency default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  budget_id name  type string format string title  description The budget ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 4 examples  refName  budget_name name  type string format string title  description The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  category_id name  type string format string title  description The category ID for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 43 examples  refName  category_name name  type string format string title  description The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Groceries examples  refName  source_id name  type string format string title  description ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  source_name name  type string format string title  description Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Checking account examples  refName  source_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  destination_id name  type string format string title  description ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  destination_name name  type string format string title  description Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Buy and Large examples  refName  destination_iban name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NL02ABNA0123456789 examples  refName  reconciled name  type boolean format  title  description If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  bill_id name  type string format string title  description Optional. Use either this or the bill_name default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 111 examples  refName  bill_name name  type string format string title  description Optional. Use either this or the bill_id default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Monthly rent examples  refName  tags name  type array format  title  description Array of tags. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description Tag. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Barbecue preparation examples  refName  notes name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Some example notes examples  refName  internal_reference name  type string format string title  description Reference to internal reference of other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_id name  type string format string title  description Reference to external ID in other systems. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  external_url name  type string format string title  description External, custom URL for this transaction. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_cc name  type string format string title  description SEPA Clearing Code default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_op name  type string format string title  description SEPA Opposing Account Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ct_id name  type string format string title  description SEPA end-to-end Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_db name  type string format string title  description SEPA mandate identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_country name  type string format string title  description SEPA Country default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ep name  type string format string title  description SEPA External Purpose indicator default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_ci name  type string format string title  description SEPA Creditor Identifier default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  sepa_batch_id name  type string format string title  description SEPA Batch ID default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  interest_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  book_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  process_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  due_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  payment_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  invoice_date name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:TransactionSplitUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactionsplitupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactionsplitupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/user/index.md",
      "kind": "schema",
      "title": "User",
      "description": "Fields: created_at, updated_at, email, blocked, blocked_code and role.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/user/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/user/index.md",
      "file": "api/models/user/index.md",
      "searchText": "name User type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email",
      "documentId": "schema:User",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/user/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/user/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupread/index.md",
      "kind": "schema",
      "title": "UserGroupRead",
      "description": "Fields: type, id, attributes and links.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupread/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupread/index.md",
      "file": "api/models/usergroupread/index.md",
      "searchText": "name UserGroupRead type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links",
      "documentId": "schema:UserGroupRead",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupread/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupread/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupreadattributes/index.md",
      "kind": "schema",
      "title": "UserGroupReadAttributes",
      "description": "Fields: created_at, updated_at, in_use, can_see_members, title, primary_currency_id and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadattributes/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadattributes/index.md",
      "file": "api/models/usergroupreadattributes/index.md",
      "searchText": "name UserGroupReadAttributes type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems ",
      "documentId": "schema:UserGroupReadAttributes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadattributes/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadattributes/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupreadmembers/index.md",
      "kind": "schema",
      "title": "UserGroupReadMembers",
      "description": "Fields: user_id, user_email, you and roles.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadmembers/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadmembers/index.md",
      "file": "api/models/usergroupreadmembers/index.md",
      "searchText": "name UserGroupReadMembers type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems ",
      "documentId": "schema:UserGroupReadMembers",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadmembers/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadmembers/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupreadrole/index.md",
      "kind": "schema",
      "title": "UserGroupReadRole",
      "description": "The possible roles of the user in this user group are documented in the API reference guide.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadrole/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadrole/index.md",
      "file": "api/models/usergroupreadrole/index.md",
      "searchText": "name UserGroupReadRole type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole",
      "documentId": "schema:UserGroupReadRole",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupreadrole/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupreadrole/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupsingle/index.md",
      "kind": "schema",
      "title": "UserGroupSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupsingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupsingle/index.md",
      "file": "api/models/usergroupsingle/index.md",
      "searchText": "name UserGroupSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_groups examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadAttributes properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  in_use name  type boolean format  title  description Is this user group ('financial administration') currently the active administration? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  can_see_members name  type boolean format  title  description Can the current user see the members of this user group? default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description Title of the user group. By default, it is the same as the user's email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example demo@firefly examples  refName  primary_currency_id name  type string format string title  description Returns the primary currency ID of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 12 examples  refName  primary_currency_code name  type string format string title  description Returns the primary currency code of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  primary_currency_symbol name  type string format string title  description Returns the primary currency symbol of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  primary_currency_decimal_places name  type integer format int32 title  description Returns the primary currency decimal places of the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  members name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadMembers properties user_id name  type string format string title  description The ID of the member. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  user_email name  type string format email title  description The email address of the member default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  you name  type boolean format  title  description Is this you? (the current user) default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  roles name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format  title  description The possible roles of the user in this user group are documented in the [API reference guide](/references/firefly-iii/api/). default  enum 0 ro 1 mng_trx 2 mng_meta 3 read_budgets 4 read_piggies 5 read_subscriptions 6 read_rules 7 read_recurring 8 read_webhooks 9 read_currencies 10 mng_budgets 11 mng_piggies 12 mng_subscriptions 13 mng_rules 14 mng_recurring 15 mng_webhooks 16 mng_currencies 17 view_reports 18 view_memberships 19 full 20 owner enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupReadRole uniqueItems  links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:UserGroupSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupsingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupsingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/usergroupupdate/index.md",
      "kind": "schema",
      "title": "UserGroupUpdate",
      "description": "Fields: title, primary_currency_id and primary_currency_code.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usergroupupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupupdate/index.md",
      "file": "api/models/usergroupupdate/index.md",
      "searchText": "name UserGroupUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserGroupUpdate properties title name  type string format string title  description A descriptive title for the user group. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example New user group title examples  refName  primary_currency_id name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  primary_currency_code name  type string format string title  description Use either primary_currency_id or primary_currency_code. This will set the primary currency for the user group ('financial administration'). default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  required 0 title",
      "documentId": "schema:UserGroupUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usergroupupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usergroupupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookdelivery/index.md",
      "kind": "schema",
      "title": "WebhookDelivery",
      "description": "Format of the delivered response.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookdelivery/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookdelivery/index.md",
      "file": "api/models/webhookdelivery/index.md",
      "searchText": "name WebhookDelivery type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery",
      "documentId": "schema:WebhookDelivery",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookdelivery/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookdelivery/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookdeliveryarray/index.md",
      "kind": "schema",
      "title": "WebhookDeliveryArray",
      "description": "A list of WebhookDelivery.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/index.md",
      "file": "api/models/webhookdeliveryarray/index.md",
      "searchText": "name WebhookDeliveryArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1",
      "documentId": "schema:WebhookDeliveryArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookdeliveryarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookproperties/index.md",
      "kind": "schema",
      "title": "WebhookProperties",
      "description": "Fields: created_at, updated_at, active, title, secret, triggers and 3 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookproperties/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookproperties/index.md",
      "file": "api/models/webhookproperties/index.md",
      "searchText": "name WebhookProperties type object format  title A single webhook (read) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookProperties properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url",
      "documentId": "schema:WebhookProperties",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookproperties/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookproperties/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookresponse/index.md",
      "kind": "schema",
      "title": "WebhookResponse",
      "description": "Indicator for what Firefly III will deliver to the webhook URL.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookresponse/index.md",
      "file": "api/models/webhookresponse/index.md",
      "searchText": "name WebhookResponse type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse",
      "documentId": "schema:WebhookResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookresponse/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookresponsearray/index.md",
      "kind": "schema",
      "title": "WebhookResponseArray",
      "description": "A list of WebhookResponse.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/index.md",
      "file": "api/models/webhookresponsearray/index.md",
      "searchText": "name WebhookResponseArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1",
      "documentId": "schema:WebhookResponseArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookresponsearray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookstore/index.md",
      "kind": "schema",
      "title": "WebhookStore",
      "description": "Fields: active, title, triggers, responses, deliveries and url.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookstore/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookstore/index.md",
      "file": "api/models/webhookstore/index.md",
      "searchText": "name WebhookStore type object format  title A single webhook (store) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookStore properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName  required 0 title 1 trigger 2 response 3 delivery 4 url",
      "documentId": "schema:WebhookStore",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookstore/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookstore/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhooktrigger/index.md",
      "kind": "schema",
      "title": "WebhookTrigger",
      "description": "The trigger for the webhook.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhooktrigger/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooktrigger/index.md",
      "file": "api/models/webhooktrigger/index.md",
      "searchText": "name WebhookTrigger type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger",
      "documentId": "schema:WebhookTrigger",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhooktrigger/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooktrigger/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhooktriggerarray/index.md",
      "kind": "schema",
      "title": "WebhookTriggerArray",
      "description": "A list of WebhookTrigger.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/index.md",
      "file": "api/models/webhooktriggerarray/index.md",
      "searchText": "name WebhookTriggerArray type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3",
      "documentId": "schema:WebhookTriggerArray",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhooktriggerarray/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookupdate/index.md",
      "kind": "schema",
      "title": "WebhookUpdate",
      "description": "Fields: active, title, secret, triggers, responses, deliveries and 1 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookupdate/index.md",
      "file": "api/models/webhookupdate/index.md",
      "searchText": "name WebhookUpdate type object format  title A single webhook (update) description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookUpdate properties active name  type boolean format  title  description Boolean to indicate if the webhook is active default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  title name  type string format string title  description A title for the webhook for easy recognition. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Update magic mirror on new transaction examples  refName  secret name  type string format string title  description A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example iMLZLtLx2JHWhK9Dtyuoqyir examples  refName  triggers name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 STORE_TRANSACTION 1 UPDATE_TRANSACTION examples  refName WebhookTriggerArray items name  type string format string title  description The trigger for the webhook. default  enum 0 ANY 1 STORE_TRANSACTION 2 UPDATE_TRANSACTION 3 DESTROY_TRANSACTION 4 STORE_BUDGET 5 UPDATE_BUDGET 6 DESTROY_BUDGET 7 STORE_UPDATE_BUDGET_LIMIT enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example DESTROY_TRANSACTION examples  refName WebhookTrigger minItems 1 maxItems 3 responses name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 TRANSACTIONS examples  refName WebhookResponseArray items name  type string format string title  description Indicator for what Firefly III will deliver to the webhook URL. default  enum 0 TRANSACTIONS 1 ACCOUNTS 2 BUDGET 3 RELEVANT 4 NONE enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example RELEVANT examples  refName WebhookResponse minItems 1 maxItems 1 deliveries name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDeliveryArray items name  type string format string title  description Format of the delivered response. default  enum 0 JSON enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 0 JSON examples  refName WebhookDelivery minItems 1 maxItems 1 url name  type string format string title  description The URL of the webhook. Has to start with `https`. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://example.com examples  refName ",
      "documentId": "schema:WebhookUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookattempt/index.md",
      "kind": "schema",
      "title": "WebhookAttempt",
      "description": "Fields: created_at, updated_at, webhook_message_id, status_code, logs and response.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookattempt/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattempt/index.md",
      "file": "api/models/webhookattempt/index.md",
      "searchText": "name WebhookAttempt type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookAttempt properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  webhook_message_id name  type string format string title  description The ID of the webhook message this attempt belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  status_code name  type integer format int32 title  description The HTTP status code of the error, if any. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 404 examples  refName  logs name  type string format string title  description Internal log for this attempt. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName  response name  type string format amount title  description Webhook receiver response for this attempt, if any. May contain sensitive user data. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Page not found examples  refName ",
      "documentId": "schema:WebhookAttempt",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookattempt/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookattempt/index.md"
        }
      ]
    },
    {
      "id": "api/models/webhookmessage/index.md",
      "kind": "schema",
      "title": "WebhookMessage",
      "description": "Fields: created_at, updated_at, sent, errored, webhook_id, uuid and 1 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessage/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessage/index.md",
      "file": "api/models/webhookmessage/index.md",
      "searchText": "name WebhookMessage type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName WebhookMessage properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  sent name  type boolean format  title  description If this message is sent yet. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  errored name  type boolean format  title  description If this message has errored out. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  webhook_id name  type string format string title  description The ID of the webhook this message belongs to. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  uuid name  type string format string title  description Long UUID string for identification of this webhook message. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 7a344c02-5b52-46b1-90e6-a437431dcf07 examples  refName  message name  type string format string title  description The actual message that is sent or will be sent as JSON string. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example {some:message} examples  refName ",
      "documentId": "schema:WebhookMessage",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/webhookmessage/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/webhookmessage/index.md"
        }
      ]
    },
    {
      "id": "api/models/attachabletype/index.md",
      "kind": "schema",
      "title": "AttachableType",
      "description": "The object class to which the attachment must be linked.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/attachabletype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/attachabletype/index.md",
      "file": "api/models/attachabletype/index.md",
      "searchText": "name AttachableType type string format string title  description The object class to which the attachment must be linked. default  enum 0 Account 1 Budget 2 Bill 3 TransactionJournal 4 PiggyBank 5 Tag enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bill examples  refName AttachableType",
      "documentId": "schema:AttachableType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/attachabletype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/attachabletype/index.md"
        }
      ]
    },
    {
      "id": "api/models/autobudgetperiod/index.md",
      "kind": "schema",
      "title": "AutoBudgetPeriod",
      "description": "Period for the auto budget",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/index.md",
      "file": "api/models/autobudgetperiod/index.md",
      "searchText": "name AutoBudgetPeriod type string format string title  description Period for the auto budget default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName AutoBudgetPeriod",
      "documentId": "schema:AutoBudgetPeriod",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autobudgetperiod/index.md"
        }
      ]
    },
    {
      "id": "api/models/autobudgettype/index.md",
      "kind": "schema",
      "title": "AutoBudgetType",
      "description": "The type of auto-budget that Firefly III must create.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/autobudgettype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/autobudgettype/index.md",
      "file": "api/models/autobudgettype/index.md",
      "searchText": "name AutoBudgetType type string format string title  description The type of auto-budget that Firefly III must create. default  enum 0 reset 1 rollover 2 none 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example reset examples  refName AutoBudgetType",
      "documentId": "schema:AutoBudgetType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/autobudgettype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/autobudgettype/index.md"
        }
      ]
    },
    {
      "id": "api/models/billrepeatfrequency/index.md",
      "kind": "schema",
      "title": "BillRepeatFrequency",
      "description": "How often the bill must be paid.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/index.md",
      "file": "api/models/billrepeatfrequency/index.md",
      "searchText": "name BillRepeatFrequency type string format string title  description How often the bill must be paid. default  enum 0 weekly 1 monthly 2 quarterly 3 half-year 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName BillRepeatFrequency",
      "documentId": "schema:BillRepeatFrequency",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/billrepeatfrequency/index.md"
        }
      ]
    },
    {
      "id": "api/models/polymorphicproperty/index.md",
      "kind": "schema",
      "title": "PolymorphicProperty",
      "description": "PolymorphicProperty",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/index.md",
      "file": "api/models/polymorphicproperty/index.md",
      "searchText": "name PolymorphicProperty type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem",
      "documentId": "schema:PolymorphicProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/polymorphicproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencerepetitiontype/index.md",
      "kind": "schema",
      "title": "RecurrenceRepetitionType",
      "description": "The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitiontype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitiontype/index.md",
      "file": "api/models/recurrencerepetitiontype/index.md",
      "searchText": "name RecurrenceRepetitionType type string format string title  description The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week. default  enum 0 daily 1 weekly 2 ndom 3 monthly 4 yearly enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example weekly examples  refName RecurrenceRepetitionType",
      "documentId": "schema:RecurrenceRepetitionType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitiontype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencerepetitiontype/index.md"
        }
      ]
    },
    {
      "id": "api/models/recurrencetransactiontype/index.md",
      "kind": "schema",
      "title": "RecurrenceTransactionType",
      "description": "One of: withdrawal, transfer and deposit.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactiontype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactiontype/index.md",
      "file": "api/models/recurrencetransactiontype/index.md",
      "searchText": "name RecurrenceTransactionType type string format string title  description  default  enum 0 withdrawal 1 transfer 2 deposit enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName RecurrenceTransactionType",
      "documentId": "schema:RecurrenceTransactionType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactiontype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/recurrencetransactiontype/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruleactionkeyword/index.md",
      "kind": "schema",
      "title": "RuleActionKeyword",
      "description": "The type of thing this action will do. A limited set is possible.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionkeyword/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionkeyword/index.md",
      "file": "api/models/ruleactionkeyword/index.md",
      "searchText": "name RuleActionKeyword type string format string title  description The type of thing this action will do. A limited set is possible. default  enum 0 user_action 1 set_category 2 clear_category 3 set_budget 4 clear_budget 5 add_tag 6 remove_tag 7 remove_all_tags 8 set_description 9 append_description 10 prepend_description 11 set_source_account 12 set_destination_account 13 set_notes 14 append_notes 15 prepend_notes 16 clear_notes 17 link_to_bill 18 convert_withdrawal 19 convert_deposit 20 convert_transfer 21 delete_transaction enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example set_category examples  refName RuleActionKeyword",
      "documentId": "schema:RuleActionKeyword",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruleactionkeyword/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruleactionkeyword/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruletriggerkeyword/index.md",
      "kind": "schema",
      "title": "RuleTriggerKeyword",
      "description": "The type of thing this trigger responds to. A limited set is possible",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/index.md",
      "file": "api/models/ruletriggerkeyword/index.md",
      "searchText": "name RuleTriggerKeyword type string format string title  description The type of thing this trigger responds to. A limited set is possible default  enum 0 from_account_starts 1 from_account_ends 2 from_account_is 3 from_account_contains 4 to_account_starts 5 to_account_ends 6 to_account_is 7 to_account_contains 8 amount_less 9 amount_exactly 10 amount_more 11 description_starts 12 description_ends 13 description_contains 14 description_is 15 transaction_type 16 category_is 17 budget_is 18 tag_is 19 currency_is 20 has_attachments 21 has_no_category 22 has_any_category 23 has_no_budget 24 has_any_budget 25 has_no_tag 26 has_any_tag 27 notes_contains 28 notes_starts 29 notes_end 30 notes_are 31 no_notes 32 any_notes 33 source_account_is 34 destination_account_is 35 source_account_starts enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example user_action examples  refName RuleTriggerKeyword",
      "documentId": "schema:RuleTriggerKeyword",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggerkeyword/index.md"
        }
      ]
    },
    {
      "id": "api/models/ruletriggertype/index.md",
      "kind": "schema",
      "title": "RuleTriggerType",
      "description": "Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggertype/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggertype/index.md",
      "file": "api/models/ruletriggertype/index.md",
      "searchText": "name RuleTriggerType type string format string title  description Which action is necessary for the rule to fire? Use either store-journal, update-journal or manual-activation. default  enum 0 store-journal 1 update-journal 2 manual-activation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example store-journal examples  refName RuleTriggerType",
      "documentId": "schema:RuleTriggerType",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/ruletriggertype/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/ruletriggertype/index.md"
        }
      ]
    },
    {
      "id": "api/models/stringarrayitem/index.md",
      "kind": "schema",
      "title": "StringArrayItem",
      "description": "The actual preference content.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/stringarrayitem/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/stringarrayitem/index.md",
      "file": "api/models/stringarrayitem/index.md",
      "searchText": "name StringArrayItem type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem",
      "documentId": "schema:StringArrayItem",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/stringarrayitem/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/stringarrayitem/index.md"
        }
      ]
    },
    {
      "id": "api/models/userblockedcodeproperty/index.md",
      "kind": "schema",
      "title": "UserBlockedCodeProperty",
      "description": "If you say the user must be blocked, this will be the reason code.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/userblockedcodeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/userblockedcodeproperty/index.md",
      "file": "api/models/userblockedcodeproperty/index.md",
      "searchText": "name UserBlockedCodeProperty type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty",
      "documentId": "schema:UserBlockedCodeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/userblockedcodeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/userblockedcodeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/userroleproperty/index.md",
      "kind": "schema",
      "title": "UserRoleProperty",
      "description": "Role for the user. Can be empty or omitted.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/userroleproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/userroleproperty/index.md",
      "file": "api/models/userroleproperty/index.md",
      "searchText": "name UserRoleProperty type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty",
      "documentId": "schema:UserRoleProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/userroleproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/userroleproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/basicsummary/index.md",
      "kind": "schema",
      "title": "BasicSummary",
      "description": "BasicSummary",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/basicsummary/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/basicsummary/index.md",
      "file": "api/models/basicsummary/index.md",
      "searchText": "name BasicSummary type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BasicSummary additionalProperties name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BasicSummaryEntry properties key name  type string format string title  description This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example balance-in-EUR examples  refName  title name  type string format string title  description A translated title for the information shared. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Balance ($) examples  refName  monetary_value name  type number format double title  description The amount as a float. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals for the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  no_available_budgets name  type boolean format  title  description True if there are no available budgets available. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  value_parsed name  type string format string title  description The amount formatted according to the users locale default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ 12.45 examples  refName  sub_title name  type string format string title  description A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $20 + $-40 examples  refName ",
      "documentId": "schema:BasicSummary",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/basicsummary/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/basicsummary/index.md"
        }
      ]
    },
    {
      "id": "api/models/basicsummaryentry/index.md",
      "kind": "schema",
      "title": "BasicSummaryEntry",
      "description": "Fields: key, title, monetary_value, currency_id, currency_code, currency_symbol and 4 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/basicsummaryentry/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/basicsummaryentry/index.md",
      "file": "api/models/basicsummaryentry/index.md",
      "searchText": "name BasicSummaryEntry type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BasicSummaryEntry properties key name  type string format string title  description This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example balance-in-EUR examples  refName  title name  type string format string title  description A translated title for the information shared. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Balance ($) examples  refName  monetary_value name  type number format double title  description The amount as a float. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 123.45 examples  refName  currency_id name  type string format string title  description The currency ID of the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 5 examples  refName  currency_code name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName  currency_symbol name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ examples  refName  currency_decimal_places name  type integer format int32 title  description Number of decimals for the associated currency. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  no_available_budgets name  type boolean format  title  description True if there are no available budgets available. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  value_parsed name  type string format string title  description The amount formatted according to the users locale default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $ 12.45 examples  refName  sub_title name  type string format string title  description A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example $20 + $-40 examples  refName ",
      "documentId": "schema:BasicSummaryEntry",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/basicsummaryentry/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/basicsummaryentry/index.md"
        }
      ]
    },
    {
      "id": "api/models/configuration/index.md",
      "kind": "schema",
      "title": "Configuration",
      "description": "Fields: title, value and editable.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configuration/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configuration/index.md",
      "file": "api/models/configuration/index.md",
      "searchText": "name Configuration type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Configuration properties title name  type string format  title  description Title of the configuration value. default  enum 0 configuration.is_demo_site 1 configuration.permission_update_check 2 configuration.last_update_check 3 configuration.single_user_mode 4 firefly.version 5 firefly.default_location 6 firefly.account_to_transaction 7 firefly.allowed_opposing_types 8 firefly.accountRoles 9 firefly.valid_liabilities 10 firefly.interest_periods 11 firefly.enable_external_map 12 firefly.expected_source_types 13 app.timezone 14 firefly.bill_periods 15 firefly.credit_card_types 16 firefly.languages 17 firefly.valid_view_ranges 18 cer.enabled 19 firefly.preselected_accounts 20 firefly.rule-actions 21 firefly.context-rule-actions 22 search.operators 23 webhook.triggers 24 webhook.responses 25 webhook.deliveries enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example configuration.is_demo_site examples  refName ConfigValueFilter value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem editable name  type boolean format  title  description If this config variable can be edited by the user default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  required 0 title 1 value 2 editable",
      "documentId": "schema:Configuration",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configuration/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configuration/index.md"
        }
      ]
    },
    {
      "id": "api/models/configurationupdate/index.md",
      "kind": "schema",
      "title": "ConfigurationUpdate",
      "description": "Field: value.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/configurationupdate/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationupdate/index.md",
      "file": "api/models/configurationupdate/index.md",
      "searchText": "name ConfigurationUpdate type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ConfigurationUpdate properties value name  type  format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName PolymorphicProperty oneOf 0 name  type boolean format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  1 name  type string format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  2 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  3 name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description The actual preference content. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example EUR examples  refName StringArrayItem required 0 value",
      "documentId": "schema:ConfigurationUpdate",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/configurationupdate/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/configurationupdate/index.md"
        }
      ]
    },
    {
      "id": "api/models/cronresult/index.md",
      "kind": "schema",
      "title": "CronResult",
      "description": "Fields: recurring_transactions, auto_budgets, exchange_rates, bill_notifications and webhooks.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/cronresult/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/cronresult/index.md",
      "file": "api/models/cronresult/index.md",
      "searchText": "name CronResult type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResult properties recurring_transactions name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  auto_budgets name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  exchange_rates name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  bill_notifications name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  webhooks name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName ",
      "documentId": "schema:CronResult",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/cronresult/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/cronresult/index.md"
        }
      ]
    },
    {
      "id": "api/models/cronresultrow/index.md",
      "kind": "schema",
      "title": "CronResultRow",
      "description": "Fields: job_fired, job_succeeded, job_errored, message and user.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/cronresultrow/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/cronresultrow/index.md",
      "file": "api/models/cronresultrow/index.md",
      "searchText": "name CronResultRow type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName CronResultRow properties job_fired name  type boolean format  title  description This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs\nonly fire every 24 hours, for example.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_succeeded name  type boolean format  title  description This value tells you if this specific cron job actually did something. The job may fire but not\nchange anything.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  job_errored name  type boolean format  title  description If the cron job ran into some kind of an error, this value will be true. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  message name  type string format string title  description If the cron job ran into some kind of an error, this value will be the error message. The success message\nif the job actually ran OK.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Cron result message examples  refName  user name  type string format string title  description The user for which this particular job result is.\n default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName ",
      "documentId": "schema:CronResultRow",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/cronresultrow/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/cronresultrow/index.md"
        }
      ]
    },
    {
      "id": "api/models/releasenotes/index.md",
      "kind": "schema",
      "title": "ReleaseNotes",
      "description": "Fields: version, release_notes and release_notes_markdown.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/releasenotes/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/releasenotes/index.md",
      "file": "api/models/releasenotes/index.md",
      "searchText": "name ReleaseNotes type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ReleaseNotes properties version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  release_notes name  type string format string title  description The release notes as HTML. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  release_notes_markdown name  type string format string title  description The release notes in Markdown format. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:ReleaseNotes",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/releasenotes/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/releasenotes/index.md"
        }
      ]
    },
    {
      "id": "api/models/systeminfo/index.md",
      "kind": "schema",
      "title": "SystemInfo",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/systeminfo/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/systeminfo/index.md",
      "file": "api/models/systeminfo/index.md",
      "searchText": "name SystemInfo type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName SystemInfo properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  api_version name  type string format string title  description Same value as the version field. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 6.7.8 examples  refName  php_version name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 8.1.5 examples  refName  os name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Linux examples  refName  driver name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example mysql examples  refName ",
      "documentId": "schema:SystemInfo",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/systeminfo/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/systeminfo/index.md"
        }
      ]
    },
    {
      "id": "api/models/usersingle/index.md",
      "kind": "schema",
      "title": "UserSingle",
      "description": "Field: data.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/usersingle/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/usersingle/index.md",
      "file": "api/models/usersingle/index.md",
      "searchText": "name UserSingle type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserSingle properties data name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UserRead properties type name  type string format string title  description Immutable value default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example users examples  refName  id name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2 examples  refName  attributes name  type object format  title A single user description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName User properties created_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  updated_at name  type string format date-time title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 2026-10-01T00:00:00+00:00 examples  refName  email name  type string format email title  description The new users email address. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example james@firefly-iii.org examples  refName  blocked name  type boolean format  title  description Boolean to indicate if the user is blocked. default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type string format string title  description If you say the user must be blocked, this will be the reason code. default  enum 0 email_changed 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example email_changed examples  refName UserBlockedCodeProperty role name  type string format string title  description Role for the user. Can be empty or omitted. default  enum 0 owner 1 demo 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example owner examples  refName UserRoleProperty required 0 email links name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ObjectLink properties 0 name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties rel name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example self examples  refName  uri name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example /OBJECTS/1 examples  refName  self name  type string format uri title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example https://demo.firefly-iii.org/api/v1/OBJECTS/1 examples  refName  required 0 type 1 id 2 attributes 3 links required 0 data",
      "documentId": "schema:UserSingle",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/usersingle/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/usersingle/index.md"
        }
      ]
    },
    {
      "id": "api/models/accounttypefilter/index.md",
      "kind": "schema",
      "title": "AccountTypeFilter",
      "description": "One of: all, asset, cash, expense, revenue, special and 15 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accounttypefilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accounttypefilter/index.md",
      "file": "api/models/accounttypefilter/index.md",
      "searchText": "name AccountTypeFilter type string format  title  description  default  enum 0 all 1 asset 2 cash 3 expense 4 revenue 5 special 6 hidden 7 liability 8 liabilities 9 Default account 10 Cash account 11 Asset account 12 Expense account 13 Revenue account 14 Initial balance account 15 Beneficiary account 16 Import account 17 Reconciliation account 18 Loan 19 Debt 20 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName AccountTypeFilter",
      "documentId": "schema:AccountTypeFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accounttypefilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accounttypefilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactiontypefilter/index.md",
      "kind": "schema",
      "title": "TransactionTypeFilter",
      "description": "One of: all, withdrawal, withdrawals, expense, deposit, deposits and 8 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactiontypefilter/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactiontypefilter/index.md",
      "file": "api/models/transactiontypefilter/index.md",
      "searchText": "name TransactionTypeFilter type string format  title  description  default  enum 0 all 1 withdrawal 2 withdrawals 3 expense 4 deposit 5 deposits 6 income 7 transfer 8 transfers 9 opening_balance 10 reconciliation 11 special 12 specials 13 default enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName TransactionTypeFilter",
      "documentId": "schema:TransactionTypeFilter",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactiontypefilter/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactiontypefilter/index.md"
        }
      ]
    },
    {
      "id": "api/models/meta/index.md",
      "kind": "schema",
      "title": "Meta",
      "description": "Field: pagination.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/meta/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/meta/index.md",
      "file": "api/models/meta/index.md",
      "searchText": "name Meta type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName Meta properties pagination name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties total name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 3 examples  refName  count name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 20 examples  refName  per_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 100 examples  refName  current_page name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName  total_pages name  type integer format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1 examples  refName ",
      "documentId": "schema:Meta",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/meta/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/meta/index.md"
        }
      ]
    },
    {
      "id": "api/models/accountroleproperty/index.md",
      "kind": "schema",
      "title": "AccountRoleProperty",
      "description": "Is only mandatory when the type is asset.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accountroleproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accountroleproperty/index.md",
      "file": "api/models/accountroleproperty/index.md",
      "searchText": "name AccountRoleProperty type string format string title  description Is only mandatory when the type is asset. default  enum 0 defaultAsset 1 sharedAsset 2 savingAsset 3 ccAsset 4 cashWalletAsset 5  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example defaultAsset examples  refName AccountRoleProperty",
      "documentId": "schema:AccountRoleProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accountroleproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accountroleproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/accounttypeproperty/index.md",
      "kind": "schema",
      "title": "AccountTypeProperty",
      "description": "One of: Default account, Cash account, Asset account, Expense account, Revenue account, Initial balance account and 6 more.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/accounttypeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/accounttypeproperty/index.md",
      "file": "api/models/accounttypeproperty/index.md",
      "searchText": "name AccountTypeProperty type string format string title  description  default  enum 0 Default account 1 Cash account 2 Asset account 3 Expense account 4 Revenue account 5 Initial balance account 6 Beneficiary account 7 Import account 8 Reconciliation account 9 Loan 10 Debt 11 Mortgage enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Asset account examples  refName AccountTypeProperty",
      "documentId": "schema:AccountTypeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/accounttypeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/accounttypeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/chartdatasetperiodproperty/index.md",
      "kind": "schema",
      "title": "ChartDatasetPeriodProperty",
      "description": "Period of the chart.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/chartdatasetperiodproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdatasetperiodproperty/index.md",
      "file": "api/models/chartdatasetperiodproperty/index.md",
      "searchText": "name ChartDatasetPeriodProperty type string format string title  description Period of the chart. default  enum 0 1D 1 1W 2 1M 3 3M 4 1Y 5 custom enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example 1M examples  refName ChartDatasetPeriodProperty",
      "documentId": "schema:ChartDatasetPeriodProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/chartdatasetperiodproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/chartdatasetperiodproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/creditcardtypeproperty/index.md",
      "kind": "schema",
      "title": "CreditCardTypeProperty",
      "description": "Mandatory when the account_role is ccAsset. Can only be monthlyFull or null.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/index.md",
      "file": "api/models/creditcardtypeproperty/index.md",
      "searchText": "name CreditCardTypeProperty type string format string title  description Mandatory when the account_role is ccAsset. Can only be monthlyFull or null. default  enum 0 monthlyFull 1  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthlyFull examples  refName CreditCardTypeProperty",
      "documentId": "schema:CreditCardTypeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/interestperiodproperty/index.md",
      "kind": "schema",
      "title": "InterestPeriodProperty",
      "description": "Mandatory when type is liability. Period over which the interest is calculated.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/index.md",
      "file": "api/models/interestperiodproperty/index.md",
      "searchText": "name InterestPeriodProperty type string format string title  description Mandatory when type is liability. Period over which the interest is calculated. default  enum 0 daily 1 weekly 2 monthly 3 quarterly 4 half-year 5 yearly 6  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example monthly examples  refName InterestPeriodProperty",
      "documentId": "schema:InterestPeriodProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/liabilitydirectionproperty/index.md",
      "kind": "schema",
      "title": "LiabilityDirectionProperty",
      "description": "'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/index.md",
      "file": "api/models/liabilitydirectionproperty/index.md",
      "searchText": "name LiabilityDirectionProperty type string format string title  description 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities. default  enum 0 credit 1 debit 2  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example credit examples  refName LiabilityDirectionProperty",
      "documentId": "schema:LiabilityDirectionProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/liabilitytypeproperty/index.md",
      "kind": "schema",
      "title": "LiabilityTypeProperty",
      "description": "Mandatory when type is liability. Specifies the exact type.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/index.md",
      "file": "api/models/liabilitytypeproperty/index.md",
      "searchText": "name LiabilityTypeProperty type string format string title  description Mandatory when type is liability. Specifies the exact type. default  enum 0 loan 1 debt 2 mortgage 3  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example loan examples  refName LiabilityTypeProperty",
      "documentId": "schema:LiabilityTypeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/shortaccounttypeproperty/index.md",
      "kind": "schema",
      "title": "ShortAccountTypeProperty",
      "description": "Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/index.md",
      "file": "api/models/shortaccounttypeproperty/index.md",
      "searchText": "name ShortAccountTypeProperty type string format string title  description Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. default  enum 0 asset 1 expense 2 import 3 revenue 4 cash 5 liability 6 liabilities 7 initial-balance 8 reconciliation enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example asset examples  refName ShortAccountTypeProperty",
      "documentId": "schema:ShortAccountTypeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/transactiontypeproperty/index.md",
      "kind": "schema",
      "title": "TransactionTypeProperty",
      "description": "One of: withdrawal, deposit, transfer, reconciliation and opening balance.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/transactiontypeproperty/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/transactiontypeproperty/index.md",
      "file": "api/models/transactiontypeproperty/index.md",
      "searchText": "name TransactionTypeProperty type string format string title  description  default  enum 0 withdrawal 1 deposit 2 transfer 3 reconciliation 4 opening balance enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example withdrawal examples  refName TransactionTypeProperty",
      "documentId": "schema:TransactionTypeProperty",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/transactiontypeproperty/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/transactiontypeproperty/index.md"
        }
      ]
    },
    {
      "id": "api/models/badrequestresponse/index.md",
      "kind": "schema",
      "title": "BadRequestResponse",
      "description": "Fields: message and exception.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/badrequestresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md",
      "file": "api/models/badrequestresponse/index.md",
      "searchText": "name BadRequestResponse type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName BadRequestResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Bad Request examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example BadRequestHttpException examples  refName ",
      "documentId": "schema:BadRequestResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/badrequestresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md"
        }
      ]
    },
    {
      "id": "api/models/internalexceptionresponse/index.md",
      "kind": "schema",
      "title": "InternalExceptionResponse",
      "description": "Fields: message and exception.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md",
      "file": "api/models/internalexceptionresponse/index.md",
      "searchText": "name InternalExceptionResponse type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName InternalExceptionResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Internal Exception examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example InternalException examples  refName ",
      "documentId": "schema:InternalExceptionResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md"
        }
      ]
    },
    {
      "id": "api/models/notfoundresponse/index.md",
      "kind": "schema",
      "title": "NotFoundResponse",
      "description": "Fields: message and exception.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/notfoundresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md",
      "file": "api/models/notfoundresponse/index.md",
      "searchText": "name NotFoundResponse type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName NotFoundResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Resource not found examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example NotFoundHttpException examples  refName ",
      "documentId": "schema:NotFoundResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/notfoundresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md"
        }
      ]
    },
    {
      "id": "api/models/unauthenticatedresponse/index.md",
      "kind": "schema",
      "title": "UnauthenticatedResponse",
      "description": "Fields: message and exception.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md",
      "file": "api/models/unauthenticatedresponse/index.md",
      "searchText": "name UnauthenticatedResponse type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName UnauthenticatedResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example Unauthenticated examples  refName  exception name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example AuthenticationException examples  refName ",
      "documentId": "schema:UnauthenticatedResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md"
        }
      ]
    },
    {
      "id": "api/models/validationerrorresponse/index.md",
      "kind": "schema",
      "title": "ValidationErrorResponse",
      "description": "Fields: message and errors.",
      "tab": "api",
      "url": "https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/",
      "markdown": "https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md",
      "file": "api/models/validationerrorresponse/index.md",
      "searchText": "name ValidationErrorResponse type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ValidationErrorResponse properties message name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example The given data was invalid. examples  refName  errors name  type object format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  properties email name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  force name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  field name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  role name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  blocked_code name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  name name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  type name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  iban name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  start name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  end name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  date name  type array format  title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName  items name  type string format string title  description  default  enum  enumNames  enumDescriptions  const  nullable  readOnly  writeOnly  deprecated  example  examples  refName ",
      "documentId": "schema:ValidationErrorResponse",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/",
          "markdown": "https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md"
        }
      ]
    },
    {
      "id": "about-this-preview/index.md",
      "kind": "page",
      "title": "About this preview",
      "description": "An unofficial rebuild of the Firefly III documentation with Sourcey, and how it measures against the current site.",
      "tab": "@pages",
      "url": "https://sourcey-firefly.pages.dev/about-this-preview/",
      "markdown": "https://sourcey-firefly.pages.dev/about-this-preview/index.md",
      "file": "about-this-preview/index.md",
      "searchText": "\n# About this preview {#about-this-preview}\n\n\nThis is an unofficial preview of the Firefly III documentation, rebuilt with [Sourcey](https://sourcey.com), an open-source docs engine licensed under AGPL-3.0. It is not run by the Firefly III project. Search engines are asked not to index it, and it comes down on request, or after 30 days.\n\n\n## What it is built from {#what-it-is-built-from}\n\n\n- The documentation repository, [firefly-iii/docs](https://github.com/firefly-iii/docs) at `598c28c`, converted with `sourcey migrate`: all 143 pages at their current addresses, with every heading link still landing, the four sections in one sidebar, in the site's own Roboto and colours.\n- The [API reference](/api/) from `firefly-iii/api-docs` (v6.7.8), with a page for each of its 244 operations and 255 models. The guides' links to the Swagger site open the operation itself.\n\n\n## Measured beside the current site {#measured-beside-the-current-site}\n\n\nBoth sites were built from their own sources and served side by side on one machine, compressed as hosts serve them. Each page was opened in a fresh browser at 1440 by 1000 pixels and measured once the network settled, on 21 October 2026 with Sourcey 3.8.3.\n\n| Page | Current site: requests, download, JavaScript heap | This preview |\n| --- | --- | --- |\n| `/` | 15, 415.9 KB, 3.4 MB | 8, 165.4 KB, 0.8 MB |\n| `/how-to/firefly-iii/installation/docker/` | 15, 468.8 KB, 3.6 MB | 9, 234.7 KB, 0.8 MB |\n| `/how-to/data-importer/import/simplefin/` | 13, 376.1 KB, 3.3 MB | 7, 141.7 KB, 0.8 MB |\n| `/references/data-importer/json/` | 14, 417.5 KB, 4.4 MB | 8, 183.2 KB, 0.5 MB |\n| `/api/` and `/api/updatetransaction/`, its heaviest operation | on a separate site | 10, 231.9 KB and 231.0 KB, 0.5 MB |\n\nMost of either side's download is the site's own Roboto files, which cover Cyrillic, Greek and Vietnamese. The current site also fetches its 170 KB search index on every page; the preview's search fetches 85 to 122 KB, and only when someone searches.\n\nAs one page the API reference came to 40 MB of HTML, so each operation has a page of its own, first painting within 0.33 s: plain HTML that search engines and assistants can read and anyone can link to.\n\nThe preview builds in 19.3 s from cold, peaking at 1.34 GB of memory, against 33.5 s and 321 MB for the current site; with their caches, 3.6 s against 4.4 s. It writes 143.3 MB, of which 83.2 MB is what readers load (the current site writes 38.5 MB, 36.5 MB of it for readers) and 44.7 MB is a social card for each page.\n\n\n## For agents {#for-agents}\n\n\nEvery page and operation is also published as Markdown, with an [llms.txt](/llms.txt), a [documents index](/documents.json) and the [OpenAPI bundle](/api/openapi.json).\n\n\n## Links on the current site that no longer land {#links-on-the-current-site-that-no-longer-land}\n\n\nAll ten are on the [changelog](https://docs.firefly-iii.org/references/firefly-iii/changelog/): older entries link to documentation addresses from before the docs were reorganised, and each now answers 404.\n\n| Link | Now |\n| --- | --- |\n| `/firefly-iii/` | `/` |\n| `/firefly-iii/pages-and-features/webhooks/` | `/how-to/firefly-iii/features/webhooks/` |\n| `/concepts/search` | `/how-to/firefly-iii/features/search/` |\n| `/advanced-concepts/rules` | `/how-to/firefly-iii/features/rules/` |\n| `/advanced-installation/authentication#remote-user` | `/how-to/firefly-iii/advanced/authentication/`, which has no remote user section |\n| `/en/latest/installation/cronjob.html` | `/how-to/firefly-iii/advanced/cron/` |\n| `/importing-data/introduction` | `/tutorials/firefly-iii/importing-data/` |\n| `/firefly-iii/financial-concepts/organizing/#adjusted-and-correct-for-overspending` | no current page covers it |\n| `/support/telemetry` | no current page |\n| `/support/error_codes` | no current page |\n",
      "documentId": "about-this-preview",
      "locale": "en",
      "contentLocale": "en",
      "contentVersion": "current",
      "versionScope": "site",
      "alternates": [
        {
          "locale": "en",
          "contentVersion": "current",
          "url": "https://sourcey-firefly.pages.dev/about-this-preview/",
          "markdown": "https://sourcey-firefly.pages.dev/about-this-preview/index.md"
        }
      ]
    }
  ]
}
